GetInsuranceProducts

Filter inputs

NameTypeDescriptionMandatoryAvailable from version
BrickIdsGuid[]The BrickIds (unique id) of the insurance product.
2.02
CreatedDateFromDateTime

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
CreatedDateToDateTime

The date on which the insurance policy was created.

Filters out items created after date.


2.02
InsuranceSupplierIdsGuid[]The BrickId of the supplier of the insurance product, this is a Legal Entity that can be fetched using GetPersons.
2.02
ResllerIdsGuid[]The BrickId of the re-seller for the insurance product, this is a Legal Entity that can be fetched using GetPersons.
2.02
BrookerIdsGuid[]The BrickId of the broker for the insurance product, this is a Legal Entity that can be fetched using GetPersons.
2.02
AdministratorIdsGuid[]The BrickId of the appointed administrator for the insurance product, this is a Legal Entity that can be fetched using GetPersons.
2.02
AccountManagerIdsGuid[]The BrickId of the appointed Account manager for the insurance product, this is a Legal Entity that can be fetched using GetPersons.
2.02
ClaimsAdjusterIdsGuid[]The BrickId of the appointed Claims adjuster for the insurance product, this is a Legal Entity that can be fetched using GetPersons.
2.02
InsuranceProductTypeKeysstring[]Key for the type connected to insurance product. Documentation from the Knowledgebase can be viewed here Create Insurance Programs
2.02
InsuranceProductCategoryKeysstring[]Key for the category connected to insurance product, this can be either "Individual" or "Group"
2.02
Keysstring[]Used to uniquely identify product.
2.02
Namesstring[]Display name for product.
2.02
DescriptionStringsstring[]Description of the insurance product.
2.02
ProductCodesstring[]Product code for the insurance product
2.02
StatusKeysstring[]

Status for the insurance product. The available statuses are as follows:

ValueStatusDescription
1StartUpThe product is currently being started.
2ActiveThe product is active and open for insurance policy creation.
3DiscontinuedThe product is discontinued and no new insurance policies can be created for the program.
4TerminatedThe product is terminated with no active associated insurance policies.

2.02
Countriesstring[]Two letter country code (ISO 3166-1)
2.02
RuleOf12sdecimal[]

2.02
RuleOf45sdecimal[]

2.02
RuleOf72sdecimal[]

2.02
Currenciesstring[]Three digit currency code (ISO 4217)
2.02
InsuranceCommissionsdecimal[]The percentage value offered in commission for resellers. 10% is entered like 0.1.
2.02
Retentionsdecimal[]The retention percentage. 10% is entered like 0.1.
2.02
ProfitSharesdouble[]Profit share for the insurance product. 10% is entered like 0.1.
2.02
TermsNostring[]Terms noumber for insurance product. The number that the terms and conditions document has (often ”Year+X)
2.02
TermsUrlsstring[]URL to terms for insurance product.
2.02
ProductVersionsstring[]Product version of the insurance product.
2.02
StartDateFromDateTimeStart date for the insurance product.If one of these values are used as input both of them has to be supplied.2.02
StartDateToDateTimeStart date for the insurance product.
2.02
EndDateFromDateTimeEnd date for the insurance product.If one of these values are used as input both of them has to be supplied.2.02
EndDateToDateTimeEnd date for the insurance product.
2.02
MaxTermsstring[]The max term of the underlying loan e.g. a consumer loan with max 144 months.
2.02
InsurableInterestsstring[]Interest amount in a given month expressed in currency value
2.02
GrossPricesdecimal[]The price that the consumer pays
2.02
PremiumBasedOnsstring[]The variable that the price of the insurance is calculated on e.g. % of monthly installment or % of the outstanding balance etc.
2.02
NetPricesdecimal[]GrossPrice – Commission
2.02
ChargeIntervalsint[]The payment interval
2.02
SaleMethodsstring[]Also called Point of Sale (POS) and is e.g. DM, TM, inbound, shop etc.
2.02
ExternalReferencesstring[]A string value that can identify the insurance product for an external system.
2.02
Parametersstring[]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
Commentsstring[]

2.02
DealTypeKeysstring[]This value should be either "Direct" or "ThirdPart"
2.02
PeriodOfNoticesint[]Periods of notice for the insurance product.
2.02
RAFApprovedDateFromDateTime
If one of these values are used as input both of them has to be supplied.2.02
RAFApprovedDateToDateTime

2.02
InsuranceTaxesdecimal[]Insurance percentage, 10 % should be written like 0.10.
2.02

Response rows (Array) inherits from EntityBase

NameTypeDescriptionAvailable from version
BrickIdGuidNot used as an input.2.02
CreatedAtDateTimeDate when insurance product was created2.02
InsuranceProductSupplierGuid
2.02
ResellerGuid
2.02
BrookerGuid
2.02
AdministratorGuid
2.02
AccountManagerGuid
2.02
ClaimsAdjusterGuid
2.02
InsuranceProductTypeKeystring
2.02
InsuranceCategoryKeystring
2.02
KeystringUsed to uniquely identify this product.2.02
NamestringDisplay name for product.2.02
DescriptionStringstring
2.02
ProductCodestring
2.02
StatusKeystring

Status for the insurance product. The available statuses are as follows:

ValueStatusDescription
1StartUpThe product is currently being started.
2ActiveThe product is active and open for insurance policy creation.
3DiscontinuedThe product is discontinued and no new insurance policies can be created for the program.
4TerminatedThe product is terminated with no active associated insurance policies.
2.02
CountrystringTwo letter country code (ISO 3166-1)2.02
RuleOf12decimal
2.02
RuleOf45decimal
2.02
RuleOf78decimal
2.02
CurrencyCodestringThree digit currency code (ISO 4217)2.02
InsuranceCommissiondecimal
2.02
Retentiondecimal
2.02
ProfitSharedouble
2.02
TermsNostring
2.02
TermsUrlstring
2.02
ProductVersionstring
2.02
StartDateDateTime
2.02
EndDateDateTime
2.02
MaxTermstring
2.02
InsurableIntereststring
2.02
GrossPricedecimal
2.02
PremiumBasedOnstring
2.02
NetPricedecimal
2.02
ChargeIntervalinteger
2.02
SaleMethodstring
2.02
ExternalReferencestring
2.02
ParametersstringThis 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
Commentstring
2.02
DealTypeKeystring
2.02
PeriodOfNoticestring
2.02
RAFApprovedDateDateTime
2.02
InsuranceTaxdecimal
2.02

Code examples

C# - Get insurance products from a BFS instance
//Use the GetInsuranceProducts method
var client = new BFSServiceReference.bfsapiSoapClient();
 
var credentials = new BFSServiceReference.Credentials()
{
    UserName = bfsusername, //Username of administrative user in your instance of BFS
    Password = bfspassword, //Password of the administrative user in your instance of BFS
};
 
var products = client.GetInsuranceProducts(new BFSServiceReference.GetInsuranceProductsRequest()
{
    Credentials = credentials,
 
    identify = bfsidentifier, //Identifier is a unique token for your instance of BFS
 
    Args = new GetInsuranceProductsArgs()
    {
		InsuranceProductTypeKeys = new[] { "Car" }
    },
 
    Fields = new BFSServiceReference.GetInsuranceProductsFields()
    {
                    BrickId = true,
                    CreatedDate = true,
                    InsuranceProductSupplierId = true,
                    ResellerId = true,
                    BrokerId = true,
                    AdministratorId = true,
                    AccountManagerId = true,
                    ClaimsAdjusterId = true,
                    InsuranceProductTypeKey = true,
                    InsuranceCategoryKey = true,
                    Key = true,
                    Name = true,
                    DescriptionString = true,
                    ProductCode = true,
                    StatusKey = true,
                    Country = true,
                    RuleOf12 = true,
                    RuleOf45 = true,
                    RuleOf78 = true,
                    Currency = true,
                    InsuranceCommission = true,
                    Retention = true,
                    ProfitShare = true,
                    TermsNo = true,
                    TermsURL = true,
                    ProductVersion = true,
                    StartDate = true,
                    EndDate = true,
                    MaxTerm = true,
                    InsurableInterest = true,
                    GrossPrice = true,
                    PremiumBasedOn = true,
                    NetPrice = true,
                    ChargeInterval = true,
                    SaleMethod = true,
                    ExternalReference = true,
                    Parameters = true,
                    Comment = true,
                    DealTypeKey = true,
                    PeriodOfNotice = true,
                    RAFApprovedDate = true,
                    InsuranceTax = true
    }
});

Blog stream

Create a blog post to share news and announcements with your team and company.