The operation renewal will return financial information or calculate the rate as a result of a renewal of a policy, loan, pension, master agreement or contract within a master agreement.
How to use variants
If you want to renew a contract, choose the operation renewal. If a particular handling variant is requested, use a variant. If not, select the default variant. The variant determines which attributes are mandatory. The operation renewal uses the base-url and endpoint to address a specific contract, and the unique contract identification is part of the endpoint.
A positive response for the operation renewal 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 (in behandeling).
- If the renewal is accepted, then a complete return message (input message completed with result data) is returned.
If a negative response is generated, that 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
Two variants are defined for the operation renewal, one for the retrieval of data and the other one for the calculation of rates.
| Variant | Description | policy structure |
masterAgreement structure |
pension structure |
loan structure |
| <default> | Obtain financial booking resulting from the renewal of a contract (“PPR”) | Yes | Yes | U/C | U/C |
| rate | Calculation based on renewal data | Yes | Yes | U/C | U/C |
U/C: Under construction.
- <default> – Obtain financial booking resulting from the renewal of a contract (“PPR”)
-
Get all information of a contract after renewal in order to update the agent administration. From a functional point of view there are no mandatory input attributes, the body section can be used to provide a complete or partial set of contract information.
policyStructure
Get all information of a policy after renewal in order to update the agent administration. 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 GET { uri }/policies/{policyId}/renewal N/A N/A policyStructure
Mandatory input and/or output (I/O) attributes
Entity Attribute I/O Remarks commonFunctional dataCatalogVersion O Version of the data catalog on which the message is based. commonFunctional functionVariant O The function variant is used to determine the additional set of required and optional input and output data. commonFunctional businessLine O Classification of the type of contract. E.g. to be used for addressing within a company. commonFunctional porCompany O The identification of the insurer is necessary to find the correct product and rate combination. commonFunctional afdDefinitionName O Name of the AFD-definition. commonFunctional afdDefinitionVersion O Version of the AFD-definition. policy contractNumber O The identifying characteristic assigned by a company or underwriting agent. 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.
masterAgreementStructure
Get masterAgreement and/or subcontract information of a contract after renewal in order to update the agent administration. The mandatory attributes (in a generic way) are listed in the table Mandatory input and/or output (I/O) attributes.
It is possible to execute this operation for a subcontract by adding the contract number as a query parameter (contractnumber={contractId}). More information on query parameters is available in Design principles.
Endpoint definition
Method Endpoint Request Query
parameter(s)Response Remarks GET { uri }/master-agreements/{masterAgreementId}/renewal N/A contractnumber={contractId} masterAgreementStructure
Mandatory input and/or output (I/O) attributes
Entity Attribute I/O Remarks commonFunctional dataCatalogVersion O Version of the data catalog on which the message is based. commonFunctional functionVariant O The function variant is used to determine the additional set of required and optional input and output data. commonFunctional businessLine O Classification of the type of contract. E.g. to be used for addressing within a company. commonFunctional porCompany O The identification of the insurer is necessary to find the correct product and rate combination. commonFunctional afdDefinitionName O Name of the AFD-definition. commonFunctional afdDefinitionVersion O Version of the AFD-definition. masterAgreement contractNumber O Number of the masterAgreement contract. policy contractNumber O The identifying characteristic assigned by a company or underwriting agent. 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.
- rate – Calculation based on renewal data
-
The variant rate contains the calculation as a result of renewal of the contract.
policyStructure
The policyStructure is used to request a calculation of a rate in case of renewal of 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 PUT { uri }/policies/{policyId}/rates/renewal 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 theentityTypetransaction.policy contractNumber I/O The identifying characteristic assigned by a company or underwriting agent. policy effectiveDate I/O Date on which the data of this entity takes/took effect. policy renewalDate I/O The date of renewal of a policy policy paymentTermInMonths I/O The payment term is necessary to calculate the premium amount for the given term; monthly, bimonthly, quarterly, semesterly. coverage coverageCode I/O Standardized code to indicate the type of coverage and the (group of) risk(s) against which the coverage has been / will be taken out. 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.
masterAgreementStructure
The masterAgreementStructure is used to request a calculation of a rate for a masterAgreement in case of renewal. 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 PUT { uri }/master-agreements/{masterAgreementId}/rates/renewal 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 theentityTypetransaction.masterAgreement contractNumber I/O Number of the masterAgreement contract. policy contractNumber I/O The identifying characteristic assigned by a company or underwriting agent. policy effectiveDate I/O Date on which the data of this entity takes/took effect. policy renewalDate I/O The date of renewal of a policy policy paymentTermInMonths I/O The payment term is necessary to calculate the premium amount for the given term; monthly, bimonthly, quarterly, semesterly. coverage coverageCode I/O Standardized code to indicate the type of coverage and the (group of) risk(s) against which the coverage has been / will be taken out. 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.
Feedback
Powered by
Post your comment on this topic.