GetInsuranceProducts
Filter inputs
Name | Type | Description | Mandatory | Available from version | |||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
BrickIds | Guid[] | The BrickIds (unique id) of the insurance product. |
| 2.02 | |||||||||||||||
CreatedDateFrom | DateTime | The date on which the insurance policy was created. Filters out items created before date. | If one of these values are used as input both of them has to be supplied. | 2.02 | |||||||||||||||
CreatedDateTo | DateTime | The date on which the insurance policy was created. Filters out items created after date. |
| 2.02 | |||||||||||||||
InsuranceSupplierIds | Guid[] | The BrickId of the supplier of the insurance product, this is a Legal Entity that can be fetched using GetPersons. |
| 2.02 | |||||||||||||||
ResllerIds | Guid[] | The BrickId of the re-seller for the insurance product, this is a Legal Entity that can be fetched using GetPersons. |
| 2.02 | |||||||||||||||
BrookerIds | Guid[] | The BrickId of the broker for the insurance product, this is a Legal Entity that can be fetched using GetPersons. |
| 2.02 | |||||||||||||||
AdministratorIds | Guid[] | The BrickId of the appointed administrator for the insurance product, this is a Legal Entity that can be fetched using GetPersons. |
| 2.02 | |||||||||||||||
AccountManagerIds | 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 | |||||||||||||||
ClaimsAdjusterIds | 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 | |||||||||||||||
InsuranceProductTypeKeys | string[] | Key for the type connected to insurance product. Documentation from the Knowledgebase can be viewed here Create Insurance Programs |
| 2.02 | |||||||||||||||
InsuranceProductCategoryKeys | string[] | Key for the category connected to insurance product, this can be either "Individual" or "Group" |
| 2.02 | |||||||||||||||
Keys | string[] | Used to uniquely identify product. |
| 2.02 | |||||||||||||||
Names | string[] | Display name for product. |
| 2.02 | |||||||||||||||
DescriptionStrings | string[] | Description of the insurance product. |
| 2.02 | |||||||||||||||
ProductCodes | string[] | Product code for the insurance product |
| 2.02 | |||||||||||||||
StatusKeys | string[] | Status for the insurance product. The available statuses are as follows:
|
| 2.02 | |||||||||||||||
Countries | string[] | Two letter country code (ISO 3166-1) |
| 2.02 | |||||||||||||||
RuleOf12s | decimal[] |
|
| 2.02 | |||||||||||||||
RuleOf45s | decimal[] |
|
| 2.02 | |||||||||||||||
RuleOf72s | decimal[] |
|
| 2.02 | |||||||||||||||
Currencies | string[] | Three digit currency code (ISO 4217) |
| 2.02 | |||||||||||||||
InsuranceCommissions | decimal[] | The percentage value offered in commission for resellers. 10% is entered like 0.1. |
| 2.02 | |||||||||||||||
Retentions | decimal[] | The retention percentage. 10% is entered like 0.1. |
| 2.02 | |||||||||||||||
ProfitShares | double[] | Profit share for the insurance product. 10% is entered like 0.1. |
| 2.02 | |||||||||||||||
TermsNo | string[] | Terms noumber for insurance product. The number that the terms and conditions document has (often ”Year+X) |
| 2.02 | |||||||||||||||
TermsUrls | string[] | URL to terms for insurance product. |
| 2.02 | |||||||||||||||
ProductVersions | string[] | Product version of the insurance product. |
| 2.02 | |||||||||||||||
StartDateFrom | DateTime | Start date for the insurance product. | If one of these values are used as input both of them has to be supplied. | 2.02 | |||||||||||||||
StartDateTo | DateTime | Start date for the insurance product. |
| 2.02 | |||||||||||||||
EndDateFrom | DateTime | End date for the insurance product. | If one of these values are used as input both of them has to be supplied. | 2.02 | |||||||||||||||
EndDateTo | DateTime | End date for the insurance product. |
| 2.02 | |||||||||||||||
MaxTerms | string[] | The max term of the underlying loan e.g. a consumer loan with max 144 months. |
| 2.02 | |||||||||||||||
InsurableInterests | string[] | Interest amount in a given month expressed in currency value |
| 2.02 | |||||||||||||||
GrossPrices | decimal[] | The price that the consumer pays |
| 2.02 | |||||||||||||||
PremiumBasedOns | 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 | |||||||||||||||
NetPrices | decimal[] | GrossPrice – Commission |
| 2.02 | |||||||||||||||
ChargeIntervals | int[] | The payment interval |
| 2.02 | |||||||||||||||
SaleMethods | string[] | Also called Point of Sale (POS) and is e.g. DM, TM, inbound, shop etc. |
| 2.02 | |||||||||||||||
ExternalReferences | 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 was 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 | |||||||||||||||
Comments | string[] |
|
| 2.02 | |||||||||||||||
DealTypeKeys | string[] | This value should be either "Direct" or "ThirdPart" |
| 2.02 | |||||||||||||||
PeriodOfNotices | int[] | Periods of notice for the insurance product. |
| 2.02 | |||||||||||||||
RAFApprovedDateFrom | DateTime |
| If one of these values are used as input both of them has to be supplied. | 2.02 | |||||||||||||||
RAFApprovedDateTo | DateTime |
|
| 2.02 | |||||||||||||||
InsuranceTaxes | decimal[] | Insurance percentage, 10 % should be written like 0.10. |
| 2.02 |
Response rows (Array) inherits from EntityBase
Name | Type | Description | Available from version | ||||||
|---|---|---|---|---|---|---|---|---|---|
BrickId | Guid | Not used as an input. | 2.02 | ||||||
CreatedAt | DateTime | Date when insurance product was created | 2.02 | ||||||
InsuranceProductSupplier | Guid |
| 2.02 | ||||||
Reseller | Guid |
| 2.02 | ||||||
Brooker | Guid |
| 2.02 | ||||||
Administrator | Guid |
| 2.02 | ||||||
AccountManager | Guid |
| 2.02 | ||||||
ClaimsAdjuster | Guid |
| 2.02 | ||||||
InsuranceProductTypeKey | string |
| 2.02 | ||||||
InsuranceCategoryKey | string |
| 2.02 | ||||||
Key | string | Used to uniquely identify this product. | 2.02 | ||||||
Name | string | Display name for product. | 2.02 | ||||||
DescriptionString | string |
| 2.02 | ||||||
ProductCode | string |
| 2.02 | ||||||
StatusKey | string | Status for the insurance product. The available statuses are as follows:
|