5.4.2. Change

The operation change of a contract will replace an entity partially or completely. An entity linked to a contract can be a policy, loan, pension, master agreement or contract within an existing master agreement. The payload consists of the structures needed in the particular situation, so it can be a policyStructure or a masterAgreementStructure (see also policyStructure and masterAgreementStructure).

*The functions, variants and structures concerning pension and loan are under construction and will follow in due time.

This operation has a broad range of functional variants, but there are also technical variants in the choice of implementation.
It is possible to change an entity by completely overwriting it with a new version, or by changing only part of the existing information and leaving the rest unchanged. More information about the possible choices can be found later in this section.

The termination or expiration of a contract is grouped under the operation change, because it is often not allowed to actually delete data within a certain time period after termination or expiration.

How to use variants

If you want to make changes to an existing contract (for example a policy), choose the operation change. 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 to the operation changeContract 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 change is not accepted, then the status is rejected (afgewezen).
• If the change 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

The variant enables a differentiation in requirements to suit the specific situations (listed below), and for each variant, to which AFD structure it applies.

U/C: Under construction.

<default> – Replace a contract by a new version

The default variant replaces the entire contract by a new version.

policyStructure

The policyStructure is used to change the 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}/change	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 an 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 the entityType transaction.
policy	contractNumber	I/O	The identifying characteristic assigned by a company or underwriting agent.
policy	effectiveChangeDate	I	Date on which the change was / will be implemented.

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 replace the masterAgreement. 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) is subject to this operation and variant, one path parameter ({masterAgreementId}) is included in the endpoint. This is shown in the table below.

Method	Endpoint	Request	Query parameter(s)	Response	Remarks
PUT	{ uri }/master-agreements/{masterAgreementId}/change	masterAgreementStructure	N/A	masterAgreementStructure

If not the complete masterAgreement is subject to this operation and variant, but only a particular contract within that masterAgreement, 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
PUT	{ uri }/master-agreements/{masterAgreementId}/contracts/{contractId}/change	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 the entityType 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.
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.

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.

agent – Replace the current agent by a new agent

The variant agent is used, if the current agent of the contract needs to be replaced by a new one.

policyStructure

The policyStructure is used to change the agent 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/{policyId}/agent	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 the entityType 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	agentNumber	I/O	The agent number is a (sub) portfolio indication identifying the intermediary handling this contract.

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 change the agent 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

If the complete masterAgreement (including the underlying contracts) is subject to this operation and variant, no query parameter is included. If not the complete masterAgreement is subject to this operation and variant, but only a particular contract within that masterAgreement, a query parameter ({contractId}) is added. This is shown in the table below.

In both cases, the endpoint contains a path parameter ({masterAgreementId}).

Method	Endpoint	Request	Query parameter(s)	Response	Remarks
PATCH	{ uri }/master-agreements/{masterAgreementId}/agent	masterAgreementStructure	contractnumber={contractId}	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 the entityType 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.
masterAgreement	agentNumber	I/O	The agent number is a (sub) portfolio indication identifying the intermediary handling this contract.

Note: since the attribute “entityType” is mandatory for all used structures, it is not mentioned in this table for clarity reasons.

correction – Replace a contract by a new version due to wrong input

The variant correction is used if an entire contract needs to be replaced by a new version due to wrong input.

policyStructure

The policyStructure is used to make a correction to a policy, because of wrong input. 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}/correction	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 the entityType 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.

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 make a correction to a masterAgreement, because of wrong input. 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) is subject to this operation and variant, one path parameter ({masterAgreementId}) is included in the endpoint. This is shown in the table below.

Method	Endpoint	Request	Query parameter(s)	Response	Remarks
PUT	{ uri }/master-agreements/{masterAgreementId}/correction	masterAgreementStructure	N/A	masterAgreementStructure

If not the complete masterAgreement is subject to this operation and variant, but only a particular contract within that masterAgreement, two path parameters ({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
PUT	{ uri }/master-agreements/{masterAgreementId}/contracts/{contractId}/correction	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 the entityType 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.
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.

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.

correctionOffer – Replace the entire offer by a new version due to wrong input

The variant correctionOffer is used if the entire offer needs to be replaced by a new version due to wrong input.

policyStructure

The policyStructure is used to make a correction to an offer for a policy, because of wrong input. 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/offers/{offerId}/correction	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 the entityType transaction.
policy	offerNumber	I/O	Number of the offer.
policy	effectiveChangeDate	I/O	Date on which the change was / will be implemented.

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 make a correction to an offer for a masterAgreement, because of wrong input. 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) is subject to this operation and variant, one path parameter ({offerId}) is included in the endpoint. This is shown in the table below.

Method	Endpoint	Request	Query parameter(s)	Response	Remarks
PUT	{ uri }/master-agreements/offers/{offerId}/correction	masterAgreementStructure	N/A	masterAgreementStructure

If not the complete masterAgreement is subject to this operation and variant, but only a particular contract within that masterAgreement, two path parameters ({offerId} and {masterAgreementId}) are included in the endpoint. This is shown in the table below.

Method	Endpoint	Request	Query parameter(s)	Response	Remarks
PUT	{ uri }/master-agreements/offers/{masterAgreementId}/correction/{offerId}	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 the entityType transaction.
masterAgreement	contractNumber	I/O	The identifying characteristic assigned by a company or underwriting agent.
masterAgreement	offerNumber	I/O**	Number of the offer.  Please note: only applicable with a masterAgreement change.
masterAgreement	changeDate	I/O**	Date on which the change was / will be implemented. 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	offerNumber	I/O**	Number of the offer. 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.

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.

detail – Apply a partial change to a contract

The variant detail is used to apply a partial change to an existing contract. The data can be based on data from an existing contract. The mandatory attributes (in a generic way) are listed in the table Mandatory input and/or output (I/O) attributes.

policyStructure

The policyStructure is used to apply a partial change to an offer for a policy.

Endpoint definition

Method	Endpoint	Request	Query parameter(s)	Response	Remarks
PATCH	{ uri }/policies/{policyId}/detail	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 the entityType 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.

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 apply a partial change to an 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

If the complete masterAgreement (including the underlying contracts) is subject to this operation and variant, no query parameter is included. If not the complete masterAgreement is subject to this operation and variant, but only a particular contract within that masterAgreement, a query parameter ({contractId}) is added. This is shown in the table below.

In both cases, the endpoint contains a path parameter ({masterAgreementId}).

Method	Endpoint	Request	Query parameter(s)	Response	Remarks
PUT	{ uri }/master-agreements/{masterAgreementId}/detail	masterAgreementStructure	contractnumber={contractId}	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 the entityType 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.
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.

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.

offer – An offer for changing an existing contract

The variant offer is used if an offer is made to update an existing contract.

policyStructure

The policyStructure is used to make an offer to update an existing 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}/offer	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 the entityType 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	offerNumber	I/O	Number of the offer.

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 make an offer to update an existing masterAgreement. 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) is subject to this operation and variant, one path parameter ({masterAgreementId}) is included in the endpoint. This is shown in the table below.

Method	Endpoint	Request	Query parameter(s)	Response	Remarks
PUT	{ uri }/master-agreements/{masterAgreementId}/offer	masterAgreementStructure	N/A	masterAgreementStructure

If not the complete masterAgreement is subject to this operation and variant, but only a particular contract within that masterAgreement, two path parameters ({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
PUT	{ uri }/master-agreements/{masterAgreementId}/contracts/{contractId}/change/offer	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 the entityType transaction.
masterAgreement	contractNumber	I/O	The identifying characteristic assigned by a company or underwriting agent.
masterAgreement	offerNumber	I/O**	Number of the offer.  Please note: only applicable with a masterAgreement change.
masterAgreement	effectiveChangeDate	I/O**	Date on which the change was / will be implemented. 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	offerNumber	I/O**	Number of the offer. 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.

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.

rate – Calculation based on changed contract data

The variant rate is used, if a calculation is requested, based on changed contract data.

policyStructure

The policyStructure is used to request a calculation of a rate for a changed 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/change	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 an 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.
policy	contractNumber	I/O	The identifying characteristic assigned by a company or underwriting agent.
policy	effectiveChangeDate	I	Date on which the change was / will be implemented.
process	statusType	O	The status of the process (codelist ADNSTS) within the entityType transaction.
coverage	grossPremiumInstallment	O	Gross premium amount related to monthly installment.

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 changed masterAgreement. The mandatory attributes (in a generic way) are listed in the table Mandatory input and/or output (I/O) attributes.

Endpoint definition

The complete masterAgreement (including the underlying contracts) is subject to this operation and variant.

Method	Endpoint	Request	Query parameter(s)	Response	Remarks
PUT	{ uri }/master-agreements/{masterAgreementId}/rates/change	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 the entityType transaction.
masterAgreement	contractNumber	I/O	Number of the masterAgreement contract.
masterAgreement	effectiveChangeDate	I/O**	Date on which the change was / will be implemented. Please note: only applicable with a new rate of masterAgreement.
policy	contractNumber	I/O**	Number of particular contract. Please note: only applicable with request of a new rate of particular contract.
policy	effectiveChangeDate	I/O**	Date on which the change was / will be implemented Please note: only applicable with request of a new rate of particular contract.
policy	paymentTermInMonths	I/O**	The payment term is necessary to calculate the premium amount for the given term; monthly, bimonthly, quarterly, semesterly. Please note: only applicable with request of a new rate of particular contract.
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. Please note: only applicable with request of a new rate of particular contract.
coverage	grossPremiumInstallment	I/O**	Gross premium amount related to monthly installment. Please note: only applicable with request of a new rate of particular contract.

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.

registration – Registration of an underwritten contract for a mid-term change

The variant registration is used to register a change to an underwritten contract.

policyStructure

The policyStructure is used to register changes to a policy, in case of automatic underwriting (usually only for relatively simple risk products). 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}/registration	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 an 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.
policy	contractNumber	I/O	The identifying characteristic assigned by a company or underwriting agent.
policy	effectiveChangeDate	I	Date on which the change was / will be implemented.
process	statusType	O	The status of the process (codelist ADNSTS) within the entityType transaction.

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 register changes to a masterAgreement, in case of automatic underwriting. 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) is subject to this operation and variant, one path parameter ({masterAgreementId}) is included in the endpoint. This is shown in the table below.

Method	Endpoint	Request	Query parameter(s)	Response	Remarks
PUT	{ uri }/master-agreements/{masterAgreementId}/change/registration	masterAgreementStructure	N/A	masterAgreementStructure

If not the complete masterAgreement is subject to this operation and variant, but the registration only applies to a particular contract within the masterAgreement, two path parameters ({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
PUT	{ uri }/master-agreements/{masterAgreementId}/contracts/{contractId}/registration	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 the entityType transaction.
masterAgreement	contractNumber	I/O**	The identifying characteristic assigned by a company or underwriting agent. Please note: only applicable with a masterAgreement change.
masterAgreement	effectiveChangeDate	I/O**	Date on which the change was / will be implemented. 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.

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.

status – Change the contract (suspension) status

The variant status is used, if the status of a contract needs to be changed.

policyStructure

The policyStructure is used to change the status 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
PATCH	{ uri }/policies/{policyId}/change/status	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 the entityType 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 entityType policyDetails .

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 change the status of a masterAgreement. 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) is subject to this operation and variant, no query parameter is included. If not the complete masterAgreement is subject to this operation and variant, but only a particular contract within that masterAgreement, a query parameter ({contractId}) is added. This is shown in the table below.

In both cases, the endpoint contains a path parameter ({masterAgreementId}).

Method	Endpoint	Request	Query parameter(s)	Response	Remarks
PATCH	{ uri }/master-agreements/{masterAgreementId}/change/status	masterAgreementStructure	contractnumber={contractId}	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 the entityType transaction.
masterAgreement	contractNumber	I/O**	The identifying characteristic assigned by a company or underwriting agent. Please note: only applicable with a masterAgreement change.
masterAgreement	effectiveChangeDate	I/O**	Date on which the change was / will be implemented. Please note: only applicable with a masterAgreement change.
masterAgreement	statusType	I/O**	The status of the masterAgreement (codelist ADNSTS) .
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	I/O**	The status of the policy (codelist ADNSTS) within the entityType policyDetails .

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.