The operation termination of a contract puts an end to a policy, loan, pension, master agreement or contract within a master agreement.
How to use variants
If you want to terminate a contract, choose the operation termination. If a particular handling variant is requested, use a variant. If not, select the default variant. The variant determines which attributes are mandatory.
A positive response for the operation termination contains the AFD structure of the request as reference, with the result of the transaction (process.statusType).The requested information that was collected during the transaction, is also added to the output.
Different scenarios are possible, for example:
- If there is no immediate result available (because of manual processing), then the status is in process (pending).
- If the operation is accepted, then a complete return message (input message completed with result data) is returned.
If a negative response is generated, which means the request is technically incorrect, it follows the general rules as described in the Error section of the HTTP status codes and error handling chapter.
Variants
The operation termination
has multiple variants for contract (with and without restitution of surrender value) and offer.
Variant | Description | policy structure |
masterAgreement structure |
pension structure |
loan structure |
<default> | Terminate the contract | Yes | Yes | U/C | U/C |
offer | The offer is rejected | Yes | Yes | U/C | U/C |
surrender | Terminate the contract with restitution of the surrender value (life insurance) | Yes | Yes | U/C | U/C |
U/C: Under construction.
- <default> – Terminate the contract
-
The variant default is used, if a contract is terminated without restitution of a surrender value.
policyStructure
The policyStructure is used for the termination of a policy without restitution of a surrender value (default variant). The mandatory attributes (in a generic way) are listed in the table Mandatory input and/or output (I/O) attributes.
Endpoint definition
Method Endpoint Request Query
parameter(s)Response Remarks PATCH { uri }/policies/{policyId}/termination policyStructure N/A policyStructure
Mandatory input and/or output (I/O) attributes
Entity Attribute I/O Remarks commonFunctional dataCatalogVersion I/O Version of the data catalog on which the message is based. commonFunctional functionVariant I/O The function variant is used to determine the additional set of required and optional input and output data. commonFunctional businessLine I/O Classification of the type of contract. E.g. to be used for addressing within a company. commonFunctional porCompany I/O The identification of the insurer is necessary to find the correct product and rate combination. commonFunctional afdDefinitionName I/O Name of the AFD-definition. commonFunctional afdDefinitionVersion I/O Version of the AFD-definition. process statusType O The status of the process (codelist ADNSTS
) within theentityType
transaction.policy contractNumber I/O The identifying characteristic assigned by a company or underwriting agent. policy effectiveChangeDate I/O Date on which the change was / will be implemented. policy statusType O The status of the policy (code 3 ‘geroyeerd’ within codelist ADNSTS
) within the entityTypepolicyDetails
.Note: since the attribute “entityType” is mandatory for all used structures, it is not mentioned in this table for clarity reasons.
Because a uniform process for changes is required, a termination in the API framework must be treated as a change with
statusType
3 (‘geroyeerd’). Therefore theeffectiveChangeDate
andstatusType
are also mandatory in case of termination of a contract. Although the attributesterminationDate
andterminationReason
can be important for different purposes, they are not mandatory to define a termination within the API framework.masterAgreementStructure
The masterAgreementStructure is used for the termination of a masterAgreement without restitution of a surrender value (default variant). The mandatory attributes (in a generic way) are listed in the table Mandatory input and/or output (I/O) attributes.
Endpoint definition
If the complete
masterAgreement
(including the underlying contracts) should be terminated, one path parameter ({masterAgreementId}) is included in the endpoint. This is shown in the table below.Method Endpoint Request Query
parameter(s)Response Remarks PATCH { uri }/master-agreements/{masterAgreementId}/termination masterAgreementStructure N/A masterAgreementStructure
If not the complete
masterAgreement
should be terminated, but only a particular contract within thatmasterAgreement
, two path parameter ({masterAgreementId} and {contractId}) are included in the endpoint. This is shown in the table below. Note: in real life endpoints you should use policies, loans or pensions and their respective Ids ({policyId}, {loanId} or {pensionId}) instead of contracts (and {contractId}).Method Endpoint Request Query
parameter(s)Response Remarks PATCH { uri }/master-agreements/{masterAgreementId}/contracts/{contractId}/termination masterAgreementStructure N/A masterAgreementStructure
Mandatory input and/or output (I/O) attributes
Entity Attribute I/O Remarks commonFunctional dataCatalogVersion I/O Version of the data catalog on which the message is based. commonFunctional functionVariant I/O The function variant is used to determine the additional set of required and optional input and output data. commonFunctional businessLine I/O Classification of the type of contract. E.g. to be used for addressing within a company. commonFunctional porCompany I/O The identification of the insurer is necessary to find the correct product and rate combination. commonFunctional afdDefinitionName I/O Name of the AFD-definition. commonFunctional afdDefinitionVersion I/O Version of the AFD-definition. process statusType O The status of the process (codelist ADNSTS
) within theentityType
transaction.masterAgreement contractNumber I/O The identifying characteristic assigned by a company or underwriting agent. masterAgreement effectiveChangeDate I/O** Date on which the change was / will be implemented. Please note: only applicable with a masterAgreement change. masterAgreement statusType O** The status of the masterAgreement (code 3 ‘geroyeerd’ within codelist ADNSTS
). Please note: only applicable with a masterAgreement change.policy contractNumber I/O** The identifying characteristic assigned by a company or underwriting agent. Please note: only applicable with a policy change. policy effectiveChangeDate I/O** Date on which the change was / will be implemented. Please note: only applicable with a policy change. policy statusType O** The status of the policy (code 3 ‘geroyeerd’ within codelist ADNSTS
) within the entityTypepolicyDetails
. Please note: only applicable with a policy change.Note: since the attribute “entityType” is mandatory for all used structures, it is not mentioned in this table for clarity reasons.
** See note in the remarks.Because a uniform process for changes is required, a termination in the API framework must be treated as a change with
statusType
3 (‘geroyeerd’). Therefore theeffectiveChangeDate
andstatusType
are also mandatory in case of termination of a contract. Although the attributesterminationDate
andterminationReason
can be important for different purposes, they are not mandatory to define a termination within the API framework. - offer – The offer is rejected
-
The variant offer is used in combination with termination, if the offer is rejected and will be terminated.
policyStructure
The policyStructure is used for the termination of a rejected offer for a policy. The mandatory attributes (in a generic way) are listed in the table Mandatory input and/or output (I/O) attributes.
Endpoint definition
Method Endpoint Request Query
parameter(s)Response Remarks PATCH { uri }/policies/offers/{offerId}/termination policyStructure N/A policyStructure
Mandatory input and/or output (I/O) attributes
Entity Attribute I/O Remarks commonFunctional dataCatalogVersion I/O Version of the data catalog on which the message is based. commonFunctional functionVariant I/O The function variant is used to determine the additional set of required and optional input and output data. commonFunctional businessLine I/O Classification of the type of contract. E.g. to be used for addressing within a company. commonFunctional porCompany I/O The identification of the insurer is necessary to find the correct product and rate combination. commonFunctional afdDefinitionName I/O Name of the AFD-definition. commonFunctional afdDefinitionVersion I/O Version of the AFD-definition. process statusType O The status of the process (codelist ADNSTS
) within theentityType
transaction.policy offerNumber I/O Number of the offer. policy statusType O The status of the policy (code 0 ‘afgewezen’ within codelist ADNSTS
) within the entityTypepolicyDetails
.Note: since the attribute “entityType” is mandatory for all used structures, it is not mentioned in this table for clarity reasons.
masterAgreementStructure
The masterAgreementStructure is used for the termination of a rejected offer for a masterAgreement. The mandatory attributes (in a generic way) are listed in the table Mandatory input and/or output (I/O) attributes.
Endpoint definition
Method Endpoint Request Query
parameter(s)Response Remarks PATCH { uri }/master-agreements/offers/{offerId}/termination masterAgreementStructure N/A masterAgreementStructure
Mandatory input and/or output (I/O) attributes
Entity Attribute I/O Remarks commonFunctional dataCatalogVersion I/O Version of the data catalog on which the message is based. commonFunctional functionVariant I/O The function variant is used to determine the additional set of required and optional input and output data. commonFunctional businessLine I/O Classification of the type of contract. E.g. to be used for addressing within a company. commonFunctional porCompany I/O The identification of the insurer is necessary to find the correct product and rate combination. commonFunctional afdDefinitionName I/O Name of the AFD-definition. commonFunctional afdDefinitionVersion I/O Version of the AFD-definition. process statusType O The status of the process (codelist ADNSTS
) within theentityType
transaction.masterAgreement offerNumber I/O** Number of the offer. Please note: only applicable with a masterAgreement change. masterAgreement statusType O** The status of the masterAgreement (code 0 ‘afgewezen’ within codelist ADNSTS
). Please note: only applicable with a masterAgreement change.policy offerNumber I/O** Number of the offer. Please note: only applicable with a policy change. policy statusType O** The status of the policy (code 0 ‘afgewezen’ within codelist ADNSTS
) within the entityTypepolicyDetails
. Please note: only applicable with a policy change.Note: since the attribute “entityType” is mandatory for all used structures, it is not mentioned in this table for clarity reasons.
** See note in the remarks. - surrender – Terminate the contract with restitution of the surrender value (life insurance)
-
The variant surrender is used if a contract is terminated with restitution of a surrender value.
policyStructure
The policyStructure is used for the termination of a policy with restitution of a surrender value. The mandatory attributes (in a generic way) are listed in the table Mandatory input and/or output (I/O) attributes.
Endpoint definition
Method Endpoint Request Query
parameter(s)Response Remarks PATCH { uri }/policies/{policyId}/termination-with-surrender policyStructure N/A policyStructure
Mandatory input and/or output (I/O) attributes
Entity Attribute I/O Remarks commonFunctional dataCatalogVersion I/O Version of the data catalog on which the message is based. commonFunctional functionVariant I/O The function variant is used to determine the additional set of required and optional input and output data. commonFunctional businessLine I/O Classification of the type of contract. E.g. to be used for addressing within a company. commonFunctional porCompany I/O The identification of the insurer is necessary to find the correct product and rate combination. commonFunctional afdDefinitionName I/O Name of the AFD-definition. commonFunctional afdDefinitionVersion I/O Version of the AFD-definition. process statusType O The status of the process (codelist ADNSTS
) within theentityType
transaction.policy contractNumber I/O The identifying characteristic assigned by a company or underwriting agent. policy effectiveChangeDate I/O Date on which the change was / will be implemented. policy statusType O The status of the policy (codelist ADNSTS
) within the entityTypepolicyDetails
.coverage grossPremiumInstallment O Gross premium amount related to premium payment term in months. Note: since the attribute “entityType” is mandatory for all used structures, it is not mentioned in this table for clarity reasons.
Because a uniform process for changes is required, a termination in the API framework must be treated as a change with
statusType
3 (‘geroyeerd’). Therefore theeffectiveChangeDate
andstatusType
are also mandatory in case of termination of a contract. Although the attributesterminationDate
andterminationReason
can be important for different purposes, they are not mandatory to define a termination within the API framework.masterAgreementStructure
The masterAgreementStructure is used for the termination of a masterAgreement with restitution of a surrender value. The mandatory attributes (in a generic way) are listed in the table Mandatory input and/or output (I/O) attributes.
Endpoint definition
If the complete
masterAgreement
(including the underlying contracts) should be terminated, one path parameter ({masterAgreementId}) is included in the endpoint. This is shown in the table below.Method Endpoint Request Query
parameter(s)Response Remarks PATCH { uri }/master-agreements/{masterAgreementId}/termination-with-surrender masterAgreementStructure N/A masterAgreementStructure
If not the complete
masterAgreement
should be terminated, but only a particular contract within thatmasterAgreement
, two path parameter ({masterAgreementId} and {contractId}) are included in the endpoint. This is shown in the table below. Note: in real life endpoints you should use policies, loans or pensions and their respective Ids ({policyId}, {loanId} or {pensionId}) instead of contracts (and {contractId}).Method Endpoint Request Query
parameter(s)Response Remarks PATCH { uri }/master-agreements/{masterAgreementId}/contracts/{contractId}/termination-with-surrender masterAgreementStructure N/A masterAgreementStructure
Mandatory input and/or output (I/O) attributes
Entity Attribute I/O Remarks commonFunctional dataCatalogVersion I/O Version of the data catalog on which the message is based. commonFunctional functionVariant I/O The function variant is used to determine the additional set of required and optional input and output data. commonFunctional businessLine I/O Classification of the type of contract. E.g. to be used for addressing within a company. commonFunctional porCompany I/O The identification of the insurer is necessary to find the correct product and rate combination. commonFunctional afdDefinitionName I/O Name of the AFD-definition. commonFunctional afdDefinitionVersion I/O Version of the AFD-definition. process statusType O The status of the process (codelist ADNSTS
) within theentityType
transaction.masterAgreement contractNumber I/O The identifying characteristic assigned by a company or underwriting agent. policy contractNumber I/O The identifying characteristic assigned by a company or underwriting agent. policy effectiveChangeDate I/O Date on which the change was / will be implemented. policy statusType O The status of the policy (codelist ADNSTS
) within the entityTypepolicyDetails
.coverage grossPremiumInstallment O Gross premium amount related to premium payment term in months. Note: since the attribute “entityType” is mandatory for all used structures, it is not mentioned in this table for clarity reasons.
Because a uniform process for changes is required, a termination in the API framework must be treated as a change with
statusType
3 (‘geroyeerd’). Therefore theeffectiveChangeDate
andstatusType
are also mandatory in case of termination of a contract. Although the attributesterminationDate
andterminationReason
can be important for different purposes, they are not mandatory to define a termination within the API framework.
Post your comment on this topic.