Filter inputs
Name | Type | Description | Mandatory | Available from version |
---|---|---|---|---|
BrickId | Guid | This is the unique id of the policy that should be updated | True | |
ExpirationDate | DateTime | The expiration date for the selected insurance policy | ||
ExternalReference | string | The external reference for the selected insurance policy | ||
AccountId | Guid | The BrickId of the account associated with the selected insurance policy | ||
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". If this value is updated by this method the previous value is overwritten. | ||
PolicyPeriod | int | The policy period: Monthly = 1 Quarterly = 2 Semi annually = 3 | ||
Premium | decimal | The value of the insurance premium | ||
PremiumFrequency | int | Monthly = 1 Quarterly = 2 Semi annually = 3 | ||
SecondInsuredLegalEntityId | Guid | The BrickIds of the second insured Legal Entities | ||
SignDate | DateTime | The date when the policy was signed | ||
Status | int | 1 = Active, 2 = Inactive | ||
InitialActivationDate | DateTime | The initial activation date of the policy | ||
PeriodStartDate | DateTime | The date on which the policy period was started | ||
PeriodEndDate | DateTime | The date on which the policy period was ended | ||
LastPartnerInvoiceDate | DateTime | The date on which the associated partner invoiced the house for this insurance policy | ||
CancellationDate | DateTime | The date on which the selected insurance policy was cancelled | ||
TerminationDate | DateTime | The date on which the selected insurance policy was terminated |
Response rows (Array)
Name | Type | Description | Available from version |
---|---|---|---|
EntitiesArray | Array | All insurance policies are returned along with each insurance policy's BrickId and array of Errors per insurance policy |
Code examples
Blog stream
Create a blog post to share news and announcements with your team and company.