Edit Policy - Korint

{}

PATCH

/

policies

/

{policyId}

{}

Path Parameters

policyId

string

required

the policy's id

Query Parameters

whenAt

string

Optional: the whenAt datetime

branchId

string

Optional: the branchId

Body

application/json

customFields

object[]

custom fields per product

Show child attributes

customFields.key

string

required

key of custom field

customFields.value

required

key of custom field

name

string

Optional: Name of the entity

invoicingConfig

object

the policy's invoicing configuration

Show child attributes

invoicingConfig.frequency

enum<string>

required

Available options:

YEARLY,

MONTHLY,

BIENNIAL,

WEEKLY

invoicingConfig.reconciliationMethod

enum<string>

required

Available options:

INSTANT

invoicingConfig.timing

enum<string>

required

Available options:

IN_ADVANCE,

IN_ARREAR

invoicingConfig.billAtSignature

enum<string>

required

Available options:

EARLY_PAYMENT,

FULL,

NONE

invoicingConfig.spread

enum<string>

Available options:

DYNAMIC

invoicingConfig.earlyPayment

object

Show child attributes

invoicingConfig.earlyPayment.amount

number

required

invoicingConfig.earlyPayment.unit

enum<string>

required

Available options:

YEAR,

MONTH,

WEEK,

DAY

periodDuration

object

the policy's period duration

Show child attributes

periodDuration.amount

number

required

periodDuration.unit

enum<string>

required

Available options:

YEAR,

MONTH,

WEEK,

DAY

acceptedEmailDomains

string[]

the child policy's customer accepted email domains

acceptedQuoteOptions

object

Show child attributes

acceptedQuoteOptions.availableConfigs

object[]

required

Show child attributes

acceptedQuoteOptions.availableConfigs.tier

string

required

acceptedQuoteOptions.availableConfigs.excess

string

required

acceptedQuoteOptions.availableConfigs.perils

object[]

Show child attributes

acceptedQuoteOptions.availableConfigs.perils.id

string

required

acceptedQuoteOptions.availableConfigs.perils.required

boolean

acceptedQuoteOptions.availableConfigs.perils.options

string[]

acceptedQuoteOptions.defaultConfig

object

Show child attributes

acceptedQuoteOptions.defaultConfig.tier

string

required

acceptedQuoteOptions.defaultConfig.excess

string

required

acceptedQuoteOptions.defaultConfig.perils

object[]

Show child attributes

acceptedQuoteOptions.defaultConfig.perils.id

string

required

acceptedQuoteOptions.defaultConfig.perils.option

string

maximumNumberOfBikes

number

max number of bike

Required range: x >= 1

Response

The response is of type object.

Get Policy List my policies

⌘I