Deal Price Assignment and Commitments View Request and Response - Attribute/Value Pairs in the JSON Format

Note: We recommend you to refer the topics Deal Price Assignment and Commitments View Request in the JSON Format and Deal Price Assignment and Commitments View 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 XML format.

Before calling the C1-DealPriceAsgnCommitmentBS business service through an inbound web service, you need to ensure that the deal price assignment and commitments view 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 and commitments you want to view.
Note:

If you specify the dealIdentifier attribute, you need not specify the dealId and the modelId attributes.

If the deal has multiple versions, then, you should specify the modelId attribute instead of the dealIdentifier attribute.

 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 and commitments you want to view.
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 and commitments you want to view.
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.
actionflag Used to indicate that you want to create request to view the price assignment and commitments of the entities in the customer hierarchy of the deal. The valid value is:

  • READ

 Yes
inquiryModeFlag Used to indicate that you want to view the price assignments and commitments of the entities in the customer hierarchy of the deal. The valid value is:

  • BOTH

 Yes

Once the deal price assignment and commitments view request is created, all the details of the deal price assignment and commitments are listed in the above mentioned attributes along with the following attributes:

Attribute Name Attribute Description
pricingcmtmntdtls Displays the price assignment and commitment details of the entity in the customer hierarchy of the deal.
entityId Displays the entity whose price assignment and commitment details you are viewing.
entityType Indicates the type of the entity whose price assignment and commitment details you are viewing. The valid values are:

  • ACCT

  • PERS
entityIdentifierValue Indicates the value of the identifier type using which the entity is created in the system.
entityIdentifierType Indicates the identifier type using which the entity is created in the system.
entityDivision Indicates the division to which the entity belongs.
pricingdtls Displays the price assignment details of the entity in the customer hierarchy of the deal.
priceAsgnId Displays the identification value of the price assignment for the entity whose price assignment details you are viewing.
priceItemCode Displays the price item whose price assignment details you are viewing.
priceItemDescription Displays the description of the price item.
hierarchyDetails Displays the root level and/or non-root level hierarchy entity to which the price item belongs.
priceStatusFlag Indicates the current status of the price assignment.
priceCurrencyCode Indicates the currency in which the price assignment is defined for the price item.
rateSchedule Indicates the rate schedule using which the price assignment is defined for the price item.
startDate Displays the date from when the price assignment of the price item is effective for the entity.
endDate Displays the date till when the price assignment of the price item is effective for the entity.
isEligible Indicates whether the eligibility criteria for the price assignment is defined or not. The valid values are:

  • FALSE

  • TRUE
assignmentLevel Indicates the level at which the pricing is defined for the price item. The valid values are:

  • ACPI

  • CUPI

  • PCPI
paTypeFlag Indicates the type of price assignment. The valid values are:

  • POST

  • PPIN

  • PPPR

  • RGLR
printIfZero Indicates whether zero pricing is displayed or not. The valid values are:

  • Y

  • N
priceasgnchar Displays a list of characteristics defined for the price assignment.
characteristicType Indicates the characteristic type.
effectiveDate Displays the date from when the characteristic is effective for price assignment.
characteristicValue Displays the value of the characteristic type.
priceasgnparm Displays the list of price item parameters which are used along with the price item for determining the price assignment.
priceParmCode Indicates the pricing parameter which is associated with the price item.
priceParmVal Indicates the predefined pricing parameter value which is used for the price assignment.
txnDailyRatingCrt Indicates how and when the transaction legs mapped to the price item are rated. The valid values are:

  • DNRT

  • AGTR

  • RITA

  • RITX
ignoreSw Indicates whether transaction mapped to price item pricing are considered for billing or not. The valid values are:

  • Y

  • N
doNotAggSw Indicates whether aggregation is required while rating the transactions mapped to the price item pricing before billing. The valid values are:

  • Y

  • N
scheduleCode Indicates the transaction aggregation cycle. The valid values are:

  • DAILY

  • WEEKLY

  • MONTHLY

  • QUARTERLY

  • YEARLY
priceCompDetails Displays the price component details of the rate component defined for the price item price assignment.
priceCompTier Displays the tiering criteria of the price component.
toVal Displays the upper limit of the pricing range.
fromVal Displays the lower limit of the pricing range.
priceCriteria Indicates the tiering criterion which is used in the tiering range.
tieSeqNum Indicates the tiering sequence number.
priceparm Displays the list of parameters based on which the price items total usage is considered for determining the rate.
Note: The value in this attribute appears only when the Multi Price Parameter option type of the Multi Parameter Based Pricing (C1_​PPARM_​FLG) feature configuration is set to True.
priceParmCode Indicates the parameter which is associated with the tiering criteria.
parameterVal Displays the value for the parameter which is associated with the tiering criteria.
priceCompElig Displays the pricing eligibility criteria defined for the price component.
Note: The value in this attribute appears only when the isEligible attribute is set to TRUE and the eligibility criteria is defined for the price component.
rhsPriceParmCd Displays the parameter against which you want to compare the parameter (on the left hand side).
rhsPriceParmVal Displays the parameter value against which you want to compare the parameter (on the left hand side).
lhsPriceParmCd Displays the left hand side parameter which you want to use along with the price item for price determination.
rhsPriceParmTypeFlg Indicates 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:

  • PARAMETER - Indicates that the parameter (on the left hand side) is compared against another parameter (on the right hand side).

  • VALUE - Indicates that the parameter (on the left hand side) is compared against a parameter value.
isInsufficientFlag Indicates what should happen when the data is insufficient. The valid values are:

  • COND - Indicates that the condition with the consecutive sequence number is executed.

  • RLFS - Indicates that the action specified in the Rule False Action field is executed.

  • RLTR - Indicates that the action specified in the Rule True Action field is executed.
isFalseFlag Indicates what should happen when the condition is false (not satisfied). The valid values are:

  • COND - Indicates that the condition with the consecutive sequence number is executed.

  • RLFS - Indicates that the action specified in the Rule False Action field is executed.

  • RLTR - Indicates that the action specified in the Rule True Action field is executed.
isTrueFlag Indicates what should happen when the condition is true (satisfied). The valid values are:

  • COND - Indicates that the condition with the consecutive sequence number is executed.

  • RLFS - Indicates that the action specified in the Rule False Action field is executed.

  • RLTR - Indicates that the action specified in the Rule True Action field is executed.
operator Indicates the relational operator used to define the relation between the parameter name and the parameter value. The valid values are:

  • <

  • < =

  • < >

  • =

  • >

  • > =

  • BETWEEN

  • IN

  • LIKE

  • NOT IN
sequenceNumber Displays the order in which the pricing eligibility criteria is executed in the rule.
priceCompSequenceNo Displays the sequence number of the price component.
priceCompId Displays the identification value of the price component.
priceCompDesc Displays the description for the price component.
valueAmt Displays the rate of the price component.
priceComponentDisplay Indicates whether the price component is displayed in the bill or not. The valid values are:

  • TRUE

  • FALSE
rcMapId Displays the identification value of the rate component for the price component.
tieredFlag Displays the tiering type used for the price component. The valid values are:

  • FLAT

  • STEP

  • THRESHOLD
commitmentDetails Displays the price item commitment details for the entity (i.e. existing or prospect person or account).
priceItemCode Displays the price item whose commitment details you are viewing.
priceItemDescription Displays the description of the price item.
parameterDetails Displays the list of parameters based on which the effective pricing is defined for the price item.
parameterCode Displays the parameter based on which the effective pricing is defined for the price item..
parameterValue Displays the value of the parameter.
SQIDetails Displays the service quantity identifier details of the price item.
serviceQuantityIdentifier Displays the service quantity identifier associated with the price item.
sqiValue Displays the SQI value for the price item and parameter combination that you want to use for calculating the price item pricing.
sqiTypeFlg Indicates the status of the service quantity identifier details for calculating the price item pricing.

Related Topics

For more information on... See...
Sample deal price assignment and commitments view request and response in the JSON format Sample Deal Price Assignment and Commitments View Request and Response in the JSON Format