Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 9 Next »

Filter inputs

NameTypeDescriptionMandatoryAvailable from version
BrickIdGuidThis is the unique id of the policy that should be updatedTrue 
ExpirationDateDateTimeThe expiration date for the selected insurance policy  
ExternalReferencestringThe external reference for the selected insurance policy  
AccountIdGuidThe BrickId of the account associated with the selected insurance policy  
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". If this value is updated by this method the previous value is overwritten.  
PolicyPeriodint

The policy period:

Monthly = 1

Quarterly = 2

Semi annually = 3

  
PremiumdecimalThe value of the insurance premium  
PremiumFrequencyint

Monthly = 1

Quarterly = 2

Semi annually = 3

  
SecondInsuredLegalEntityIdGuidThe BrickIds of the second insured Legal Entities  
SignDateDateTimeThe date when the policy was signed  
Statusint1 = Active, 2 = Inactive  
InitialActivationDateDateTimeThe initial activation date of the policy  
PeriodStartDateDateTimeThe date on which the policy period was started  
PeriodEndDateDateTimeThe date on which the policy period was ended  
LastPartnerInvoiceDateDateTimeThe date on which the associated partner invoiced the house for this insurance policy  
CancellationDateDateTimeThe date on which the selected insurance policy was cancelled  
TerminationDateDateTimeThe date on which the selected insurance policy was terminated  

Response rows (Array)

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

Code examples

C# - Update insurance policy
//Update an Insurance Policy with the UpdateInsurancePolicy 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.UpdateInsurancePolicies(new BFSServiceReference.UpdateInsurancePoliciesRequest()
{
    Credentials = credentials,

    identify = bfsidentifier, //Identifier is a unique token for your instance of BFS

    Fields = new UpdateInsurancePolicyFields()
    {
        BrickId = true,
        Premium = true
    },

    Entities = new[]
    {
      new UpdateInsurancePolicy()
      {
          BrickId = new Guid("15b1f034-c9b9-4747-a03a-5bb06edd0ad1"),
          Premium = 100M,
      },
    },


});

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.

  • No labels