Deal Commitments Add Request and Response - Attribute/Value Pairs in the JSON Format
Note: We recommend you to refer the topics Deal Commitments Add Request in the JSON Format and Deal Commitments Add Response in the JSON Format in
parallel while understanding the below mentioned attributes. This
will help you to understand how the attributes are nested in the JSON
format.
Before calling the C1-DealPriceAsgnCommitmentBS business service through an inbound web service, you need to ensure that the deal commitments add request contains the following attributes:
| Attribute Name | Attribute Description | Mandatory (Yes or No) |
|---|---|---|
| dealIdentifier | Used to specify the deal which is created using a particular
identifier whose commitments you want to add. Note: If you specify
the dealIdentifier attribute, you need not
specify the dealId and the modelId attributes.
|
Yes (Conditional) Note: This data is required if you do not
specify the dealId and modelId attributes.
|
| dealId | Used to specify the deal for which you want to add commitments. Note:
If you specify the dealId attribute, you need not specify the dealIdentifier and the modelId attributes. If the deal has multiple versions, then, you should specify the modelId attribute instead of the dealId attribute. |
Yes (Conditional) Note: This data is required if you do not
specify the dealIdentifier and modelId attributes.
|
| modelId | Used to specify the deal version for which you want to add
commitments. Note: If you specify the modelId attribute, you need not specify the dealIdentifier and the dealId attributes.
|
Yes (Conditional) Note: This data is required if you do not
specify the dealIdentifier and dealId attributes.
|
| inquiryModeFlag | Used to indicate whether you want to add price assignments
or commitments of the price item for the deal. The valid value is:
|
Yes |
| pricingcmtmntdtls | Used to specify the price assignment and commitment details for the entities (i.e. existing or prospect person or account) of the deal. | Yes |
| entityId | Used to specify the entity (i.e. existing or prospect person
or account) whose price items commitments you want to add. Note:
If you specify the entityType attribute, you need to specify the entityId attribute. The entityId should belong to the modelId. |
Yes |
| entityType | Used to indicate the type of the entity (i.e. existing or
prospect person or account) whose price items commitments you want
to add. The valid values are:
Note: If you specify the entityId attribute,
you need to specify the entityType attribute.
|
Yes |
| commitmentDetails | Used to specify the price item commitment details for the entity (i.e. existing or prospect person or account). | Yes |
| priceItemCode | Used to specify the price item whose commitments you want to add for the entity (i.e. existing or prospect person or account) of the deal. | Yes |
| priceItemDescription | Used to specify the description of the price item. | No |
| parameterDetails | Used to specify the parameters based on which the effective pricing is defined for the price item. | Yes |
| parameterCode | Used to specify the parameter. | Yes |
| parameterValue | Used to specify the value of the parameter. | Yes |
| SQIDetails | Used to specify the service quantity identifier details of the price item. | Yes |
| serviceQuantityIdentifier | Used to specify the service quantity identifier associated with the price item. | Yes |
| sqiValue | Used to specify the SQI value for the price item and parameter combination that you want to use for calculating the price item pricing. | Yes |
| sqiTypeFlg | Used to indicate the status of the service quantity identifier
details for calculating the price item pricing. The valid value is:
|
Yes |
| actionFlag | Used to specify that you want to create request to add commitments
for the deal. The valid value is:
|
Yes |
Once the deal commitments are added, all the details of deal commitments are listed in the above mentioned attributes along with the following attributes:
| Attribute Name | Attribute Description |
|---|---|
| dealId | Displays the identification value of the deal for which you
have added the commitments. Note: The value in this attribute appears
when you specify the dealIdentifier or the modelId attribute while creating the add request.
|
| modelId | Displays the identification value of the deal for which you
have added the commitments. Note: The value in this attribute appears
when you specify the dealIdentifier or the dealId attribute while creating the add request.
|
Note:
Only RM (Relationship Manager) can create the deal commitments add request.
You can add commitments for a price item only when the price item and the parameter combination is valid.
Related Topics
| For more information on... | See... |
|---|---|
| Sample deal commitments add request and response in the JSON format | Sample Deal Commitments Add Request and Response in the JSON Format |