Deal Price Assignment Update Request and Response - Attribute/Value Pairs in the JSON Format
Before calling the C1-DealPriceAsgnCommitmentBS business service through an inbound web service, you need to ensure that the deal price assignment update 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 price assignments you want to update. 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 whose price assignments you want
to update. 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 whose price assignments
you want to update. 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 update the price assignments
or the commitments of the price item. 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 assignments you want to update. 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 assignments you want to update.
The valid values are:
Note: If you specify the entityId attribute,
you need to specify the entityType attribute.
|
Yes |
pricingdtls | Used to specify the price assignment details for the entity (i.e. existing or prospect person or account). | Yes |
priceAsgnId | Used to specify the identification value of the price assignment
whose details you want to update. Note: The priceAsgnId should belong to the entityId.
|
Yes |
actionFlag | Used to indicate that you want to create request to update
the price assignment of the entity (i.e. existing or prospect person
or account) of the deal. The valid value is:
|
Yes |
priceItemCode | Used to specify the price item whose price assignment you want to update for the entity (i.e. existing or prospect person or account) of the deal. | Yes |
priceStatusFlag | Used to indicate the current status of the price item price
assignment. The valid value is:
Note: You can update a price assignment of a price item only
when it is in the PRPD status.
|
Yes |
priceCurrencyCode | Used to indicate the currency in which the price assignment is defined for the price item. | Yes |
rateSchedule | Used to indicate the rate schedule using which the price assignment is defined for the price item. | Yes |
startDate | Used to specify the date from when the price assignment of the price item is effective for the entity (i.e. existing or prospect person or account). | Yes |
endDate | Used to specify the date till when the price assignment of the price item is effective for the entity (i.e. existing or prospect person or account). | No |
isEligible | Used to indicate whether you want to define the eligibility
criteria for the price assignment. The valid values are:
|
No |
paTypeFlag | Used to indicate the type of price assignment. The valid
values are:
|
Yes |
printIfZero | Used to indicate whether zero pricing should be displayed
or not. The valid values are:
|
Yes |
priceasgnchar | Used to specify a list of characteristics for the price assignment. | No |
characteristicType | Used to indicate the characteristic type. Note: You must specify
a characteristic type which is associated with the division to which
the price item belongs.
|
Yes (Conditional) Note: This data is required while defining
a characteristic for the price assignment.
|
effectiveDate | Used to specify the date from when the characteristic is effective for price assignment. | Yes (Conditional) Note: This data is required while defining
a characteristic for the price assignment.
|
characteristicValue | Used to specify the value for the characteristic type. | Yes (Conditional) Note: This data is required while defining
a characteristic for the price assignment.
|
priceasgnparm | Used to specify a list of price item parameters which are used along with the price item for determining the price assignment. | No |
priceParmCode | Used to indicate the pricing parameter which is associated
with the price item. Note: If you specify the priceParmVal attribute, you need to specify the priceParmCode attribute.
|
Yes (Conditional) Note: This data is required while specifying
the price assignment parameters for the price item.
|
priceParmVal | Used to indicate the predefined pricing parameter value which
is used for the price assignment. Note: If you specify the priceParmCode attribute, you need to specify the priceParmVal attribute.
|
Yes (Conditional) Note: This data is required while specifying
the price assignment parameters for the price item.
|
txnDailyRatingCrt | Used to indicate how and when the transaction legs mapped
to the price item are rated. The valid values are:
|
Yes |
ignoreSw | Used to indicate whether transaction mapped to price item
pricing are considered for billing or not. The valid values are:
|
No |
doNotAggSw | Used to indicate whether aggregation is required while rating
the transactions mapped to the price item pricing before billing.
The valid values are:
|
No |
scheduleCode | Used to indicate the transaction aggregation cycle. The valid
values are:
|
Yes |
priceCompDetails | Used to specify the price component details of the rate component defined for the price item price assignment. | No |
priceCompTier | Used to specify the tiering criteria of the price component. | No |
toVal | Used to specify the upper limit of the pricing range. | Yes (Conditional) Note: This data is required while specifying
the tiering criteria of the price component.
|
fromVal | Used to specify the lower limit of the pricing range. | Yes (Conditional) Note: This data is required while specifying
the tiering criteria of the price component.
|
priceCriteria | Used to indicate the tiering criterion which is used in the tiering range. | Yes (Conditional) Note: This data is required while specifying
the tiering criteria of the price component.
|
tieSeqNum | Used to indicate the tiering sequence number. | Yes (Conditional) Note: This data is required while specifying
the tiering criteria of the price component.
|
priceparm | Used to specify a list of parameters based on which the price
items total usage is considered for determining the rate. Note: You
should specify a value in this attribute only when the Multi Price Parameter option type of the Multi
Parameter Based Pricing (C1_PPARM_FLG) feature configuration
is set to True.
|
No |
priceParmCode | Used to indicate the parameter which is associated with the tiering criteria. | Yes (Conditional) Note: This data is required while specifying
the parameters for the tiering criteria of the price component.
|
parameterVal | Used to specify the value for the parameter which is associated with the tiering criteria. | Yes (Conditional) Note: This data is required while specifying
the parameters for the tiering criteria of the price component.
|
priceCompElig | Used to specify the pricing eligibility criteria for the
price component. Note: You can specify the eligibility criteria for
the price component only when the value in the isEligible attribute is set to TRUE.
|
No |
rhsPriceParmCd | Used to specify the parameter against which you want to compare the parameter (on the left hand side). | Yes (Conditional) Note: This data is required while specifying
the pricing eligibility criteria of the price component.
|
rhsPriceParmVal | Used to specify the parameter value against which you want to compare the parameter (on the left hand side). | Yes (Conditional) Note: This data is required while specifying
the pricing eligibility criteria of the price component.
|
lhsPriceParmCd | Used to specify the left hand side parameter which you want to use along with the price item for price determination. | Yes (Conditional) Note: This data is required while specifying
the pricing eligibility criteria of the price component.
|
rhsPriceParmTypeFlg | Used to indicate whether the parameter (on the left hand
side) is compared against another parameter (on the right hand side)
or directly against a parameter value. The valid values are:
|
Yes (Conditional) Note: This data is required while specifying
the pricing eligibility criteria of the price component.
|
isInsufficientFlag | Used to indicate what should happen when the data is insufficient.
The valid values are:
|
Yes (Conditional) Note: This data is required while specifying
the pricing eligibility criteria of the price component.
|
isFalseFlag | Used to indicate what should happen when the condition is
false (not satisfied). The valid values are:
|
Yes (Conditional) Note: This data is required while specifying
the pricing eligibility criteria of the price component.
|
isTrueFlag | Used to indicate what should happen when the condition is
true (satisfied). The valid values are:
|
Yes (Conditional) Note: This data is required while specifying
the pricing eligibility criteria of the price component.
|
operator | Used to indicate the relational operator used to define the
relation between the parameter name and the parameter value. The valid
values are:
|
Yes (Conditional) Note: This data is required while specifying
the pricing eligibility criteria of the price component.
|
sequenceNumber | Used to specify the order in which the pricing eligibility criteria is executed in the rule. | Yes (Conditional) Note: This data is required while specifying
the pricing eligibility criteria of the price component.
|
priceCompSequenceNo | Used to specify the sequence number of the price component. | Yes |
priceCompDesc | Used to specify the description for the price component. | No |
valueAmt | Used to specify the rate for the price component. | Yes |
priceComponentDisplay | Used to indicate whether the price component is displayed
in the bill. The valid values are:
|
Yes |
rcMapId | Used to specify the identification value of the rate component for the price component. | Yes |
tieredFlag | Used to specify the tiering type used for the price component.
The valid values are:
|
Yes |
Once the deal price assignment is updated, all the details of deal price assignment are listed in the above mentioned attributes along with the following attributes:
Attribute Name | Attribute Description |
---|---|
dealId | Displays the identification value of the deal whose price
assignments you have updated. Note: The value in this attribute appears
when you specify the dealIdentifier or the modelId attribute while creating the update request.
|
modelId | Displays the identification value of the deal version whose
price assignments you have updated. Note: The value in this attribute
appears when you specify the dealIdentifier or the dealId attribute while creating the
update request.
|
entityIdentifierValue | Indicates the identifier using which the entity (i.e. existing or prospect person or account) is created in the system. |
entityIdentifierType | Indicates the identifier type using which the entity (i.e. existing or prospect person or account) is created in the system. |
entityDivision | Indicates the division to which the entity (i.e. existing or prospect person or account) belongs. |
priceItemDescription | Displays the description of the price item. |
hierarchyDetails | Displays the hierarchy to which the price item belongs. |
assignmentLevel | Indicates the level at which the pricing is defined for the
price item. The valid values are:
|
priceCompId | Displays the identification value of the price component. |
Only RM (Relationship Manager) can create the deal price assignment update request.
You can update only the agreed price assignments and not the inherited price assignments.
On processing the request, the system creates an agreed pricing for the entity of the deal in the Proposed status.
When you create a request to update a price assignment, the system replaces the price assignment data instead of editing it. Therefore, you should provide all details of the price assignment including the data that you want to change.
Related Topics
For more information on... | See... |
---|---|
Sample deal price assignment update request and response in the JSON format | Sample Deal Price Assignment Update Request and Response in the JSON Format |