UpdateInsuranceProducts

Inputs (InsuranceProduct[] - Entities: Array of insurance products to update)

NameTypeDescriptionMandatoryAvailable from version
BrickIdGuidThis is the unique id of the product that should be updated.
True2.02
InsuranceProductSupplierIdGuidThe BrickId of the supplier of the insurance product, this is a Legal Entity that can be fetched using GetPersons.
2.02
ResellerIdGuidThe BrickId of the re-seller for the insurance product, this is a Legal Entity that can be fetched using GetPersons.
2.02
BrokerIdGuidThe BrickId of the broker for the insurance product, this is a Legal Entity that can be fetched using GetPersons.
2.02
AdministratorIdGuidThe BrickId of the appointed administrator for the insurance product, this is a Legal Entity that can be fetched using GetPersons.
2.02
AccountManagerIdGuidThe BrickId of the appointed Account manager for the insurance product, this is a Legal Entity that can be fetched using GetPersons.
2.02
ClaimsAdjusterIdGuidThe BrickId of the appointed Claims adjuster for the insurance product, this is a Legal Entity that can be fetched using GetPersons.
2.02
InsuranceProductTypeKeystringKey for the type connected to insurance product. Documentation from the Knowledgebase can be viewed here Create Insurance Programs
2.02
InsuranceCategoryKeystringKey for the category connected to insurance product, this can be either "Individual" or "Group"
2.02
KeystringUsed to uniquely identify this product.
2.02
NamestringDisplay name for product.
2.02
DescriptionStringstringDescription of the insurance product.
2.02
ProductCodestringProduct code for the insurance product.
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
InsuranceCommissiondecimalThe percentage value offered in commission for resellers. 10% is entered like 0.1.
2.02
RetentiondecimalThe retention percentage. 10% is entered like 0.1.
2.02
ProfitSharedoubleProfit share for the insurance product. 10% is entered like 0.1.
2.02
TermsNostringTerm number for insurance product. The number that the terms and conditions document has (often ”Year+X)
2.02
TermsUrlstringURL to terms for insurance product.
2.02
ProductVersionstringProduct version of the insurance product.
2.02
StartDateDateTimeStart date for the insurance product.
2.02
EndDateDateTimeEnd date for the insurance product.
2.02
MaxTermstringThe max term of the underlying loan e.g. a consumer loan with max 144 months
2.02
InsurableIntereststringInterest amount in a given month expressed in currency value
2.02
GrossPricedecimalThe price that the consumer pays
2.02
PremiumBasedOnstringThe variable that the price of the insurance is calculated on e.g. % of monthly installment or % of the outstanding balance etc.
2.02
NetPricedecimalGrossPrice – Commission
2.02
ChargeIntervalintegerThe payment interval
2.02
SaleMethodstringAlso called Point of Sale (POS) and is e.g. DM, TM, inbound, shop etc.
2.02
ExternalReferencestringA string value that can identify the insurance product for an external system.
2.02
ParametersstringThis 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
Commentstring

2.02
DealTypeKeystringThis value should be either "Direct" or "ThirdPart"
2.02
PeriodOfNoticestringPeriods of notice for the insurance product.
2.02
RAFApprovedDateDateTime

2.02
InsuranceTaxdecimalThe percentage tax value, 10% should be written like 0.1.
2.02

Response rows (Array)

NameTypeDescriptionAvailable from version
EntitiesArrayArrayAll insurance products are returned along with each insurance product's BrickId and array of Errors per insurance product




Code examples

C# - Update insurance product
// Update an Insurance Product with the UpdateInsuranceProducts 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 response = client.UpdateInsuranceProducts(new BFSServiceReference.UpdateInsuranceProductsRequest()
{
    Credentials = credentials,
 
    identify = bfsidentifier, //Identifier is a unique token for your instance of BFS
 
    Fields = new UpdateInsuranceProductFields()
    {
        BrickId = true,
        ChargeInterval = true
    },
 
    Entities = new[]
    {
      new UpdateInsuranceProduct()
      {
          BrickId = new Guid("15b1f034-c9b9-4747-a03a-5bb06edd0ad1"), // Should be the ID of an existing insurance product
          ChargeInterval = 360,
      },
    },
 
 
});
 
foreach (var c in response.Entities)
{
    Console.WriteLine(c.BrickId + ", " + response.Message);
}

Blog stream

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