Deal Extraction Request and Response - Attribute/Value Pairs in the JSON Format
Before calling the C1-DealExtractionWebService business service through an inbound web service, you need to ensure that the deal extract request contains the following attributes:
Attribute Name | Attribute Description | Mandatory (Yes or No) |
---|---|---|
dealIdentifier | Used to specify the primary identifier of the deal using
which you want to extract the details of the deal. 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 ID using which you want to extract
the details of the deal. 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 using which you want to
extract the details of the deal. 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.
|
Once the deal is extracted, all the details of deal are listed in the above mentioned attributes along with the following attributes:
Attribute Name | Attribute Description |
---|---|
dealDetails | Displays basic information about the deal. |
dealEntityDetails | Displays basic information about the entity (i.e. existing person, account, or prospect person) for which the deal is created in the system. |
personIdentifierType | Indicates the identifier type using which the person is created
in the system. Note: The value in this attribute appears only when
the value of the dealEntityType attribute is EPER.
|
personIdentifier | Displays the value of person identifier type. Note: The value
in this attribute appears only when the value of the dealEntityType attribute is EPER.
|
personId | Displays the existing person for whom the deal created in
the system. Note: The value in this attribute appears only when the
value of the dealEntityType attribute is EPER.
|
accountIdentifierType | Indicates the identifier type using which the account is
created in the system. Note: The value in this attribute appears only
when the value of the dealEntityType attribute
is EACC.
|
accountIdentifier | Displays the value of the account identifier type. Note: The
value in this attribute appears only when the value of the dealEntityType attribute is EACC.
|
accountId | Displays the existing account for which the deal is created
in the system. Note: The value in this attribute appears only when
the value of the dealEntityType attribute is EACC.
|
prsPerIdentifierType | Indicates the identifier type using which the prospect person
is created in the system. Note: The value in this attribute appears
only when the value of the dealEntityType attribute
is PRSP.
|
prsPerIdentifier | Displays the value of the prospect person identifier type. Note: The value in this attribute appears only when the value of the dealEntityType attribute is PRSP.
|
prospectPersonId | Displays the prospect person for whom the deal is created
in the system. Note: The value in this attribute appears only when
the value of the dealEntityType attribute is PRSP.
|
division | Indicates the division to which the entity (i.e. existing person, account, or prospect person) belongs. |
dealInformation | Displays the concatenated string of information about the deal separated by a comma (,). |
dealEntityType | Indicates the type of entity for which the deal is created
in the system. The valid values are:
|
customerSegment | Indicates the business component to which the entity (i.e. existing person, account, or prospect person) belongs. |
customerTier | Indicates the customer tier of the customer segment to which the entity (i.e. existing person, account, or prospect person) belongs. |
division | Indicates the division to which the deal belongs. |
accessGrp | Indicate the user group who can view and edit the details of the deal. |
dealEntityId | Displays the entity (i.e. existing person, account, or prospect person) whose deal details you are viewing. |
contractedDealFlag | Indicates whether the change in the price item pricing from
the price list affects the price item pricing offered in the deal
created for the entity (i.e. existing person, account, or prospect
person) or not. The valid values are:
|
currency | Indicates the currency in which the deal level, division level, or product level financial summary and profitability of the deal is calculated. |
dealTypeCode | Indicates the deal type using which the deal is created in the system. |
startDate | Displays the date from when the deal is effective for the entity (i.e. the existing person, account or prospect person). |
endDate | Displays the date till when the deal is effective for the entity (i.e. the existing person, account, or prospect person). |
simulationTypeFlag | Indicates the simulation type using which the cost, revenue,
and profitability of the deal is analyzed. The valid values are:
|
reviewFrequency | Indicates the timely monitoring of the deal usage as per
the commitments made by the customer. The valid values are:
|
dealDescription | Displays the description of the deal. |
dealVersionDescription | Displays the description of the deal version. |
dealFrequency | Indicates the duration in which the financial summary and
profitability of the deal is calculated through simulation. The valid
values are:
|
skipReferenceFlag | Indicates whether the deal is created by referring the pricing
and commitments of a deal which is already created in the system.
The valid values are:
|
priceSelectionDate | Displays the date from when the price lists, pricing assignments, and product enrollments are effective for simulation. |
usagePeriod | Indicates the period for which deal data is aggregated to
determine the scope of the deal. The valid values are:
|
includeHierarchyFlag | Indicates whether the child persons, grandchild persons,
and their accounts in the customer hierarchy is included in the deal
or not. The valid values are:
|
status | Indicates the current status of the deal. |
dealVersionStatus | Indicates the current status of the deal version. |
templateFlag | Indicates whether the deal is used as a template while searching
references for creating other deals. The valid values are:
|
createdDate | Displays the date when the deal is created in the system. |
acceptanceDate | Displays the date when the deal is accepted in the system
after the customer review and acceptance. Note: The data in this attribute
appears only when the deal has reached the Accepted status. If the deal status is Rejected, then
the acceptanceDate attribute specifies the
date when the deal is rejected in the system.
|
finalizedDate | Displays the date when the deal is finalized in the system. |
effectiveStartDate | Displays the date from when the proposed price list assignments, product enrollments and price assignments are effective for the deal. |
effectiveEndDate | Displays the date till when the proposed price list assignments, product enrollments and price assignments are effective for the deal. |
reviewedDate | Displays the date when the deal usage as per the commitments made by the customer is reviewed in the system. |
templateReferenceDetails | Displays the details of the template deal which is used as a reference for creating the deal. |
templateDealId | Displays the particular template deal which is used for creating the deal. |
templateDealIdentifier | Displays the primary identifier using which the template deal is created in the system. |
templateModelId | Displays the particular template deal version which is used for creating the deal. |
copyBasicDetailsFlag | Indicates whether the basic details are copied from the template
deal to the deal which is created for the entity (i.e. existing person,
account, or prospect person) or not. The valid values are:
|
copyPricingFlag | Indicates whether the price list assignments and price assignments
are copied from the template deal to the deal which is created for
the entity (i.e. existing person, account, or prospect person) or
not. The valid values are:
|
copyUsageFlag | Indicates whether the commitments from the SQI-based billable
charges are copied from the template deal to the deal which is created
for the entity (i.e. existing person, account, or prospect person)
or not. The valid values are:
|
dealCharacteristics | Displays the list of characteristics of the deal. |
effectiveDate | Displays the date from when the characteristic is effective for the deal. |
characteristicType | Indicates the characteristic type. |
characteristicValue | Displays the value of the characteristic type. |
dealTermsAndConditionsDetails | Displays the list of terms and conditions which are associated with the deal. |
termsAndConditionsList | Displays the terms and conditions of the deal. |
termsAndCondition | Displays the term and condition which is associated with the deal. |
description | Displays the description of the term and condition. |
termsAndConditionText | Displays additional information about the term and condition. |
productDetailsList | Displays the list of products recommended for the deal. |
productCode | Displays the product which is recommended for the deal. |
referenceDetails | Displays the details of the reference deal using which the deal is created for the entity (i.e. existing person, account, or prospect person) in the system. |
referenceTypeFlg | Indicates the type of the reference deal using which the
deal is created for the entity (i.e. existing person, account, or
prospect person) in the system. The valid values are:
|
refPersonIdentifierType | Displays the identifier type of the person using which the
reference deal is created in the system. Note: The value in this attribute
appears only when the value of the referenceTypeFlg attribute is RPER.
|
refPersonIdentifier | Displays the value of the reference person identifier type. Note: The value in this attribute appears only when the value of the referenceTypeFlg attribute is RPER.
|
referPersonId | Displays the person for whom the reference deal is created. Note: The value in this attribute appears only when the value of the referenceTypeFlg attribute is RPER.
|
refAccountIdentifierType | Displays the identifier type of the account using which the
reference deal is created in the system. Note: The value in this attribute
appears only when the value of the referenceTypeFlg attribute is RACC.
|
refAccountIdentifier | Displays the value of the reference account identifier type. Note: The value in this attribute appears only when the value of the referenceTypeFlg attribute is RACC.
|
referAccountId | Display the account for which the reference deal is created. Note: The value in this attribute appears only when the value of the referenceTypeFlg attribute is RACC.
|
referDealIdentifier | Displays the primary identifier using which the reference
deal is created in the system. Note: The value in this attribute appears
only when the value of the referenceTypeFlg attribute is RDEL.
|
referenceDealId | Displays the existing deal which is used as a reference to
create the deal. Note: The value in this attribute appears only when
the value of the referenceTypeFlg attribute
is RDEL.
|
referenceModelId | Displays the existing deal version which is used as a reference
to create the deal. Note: The value in this attribute appears only
when the value of the referenceTypeFlg attribute
is RDEL.
|
referUsageSw | Indicates whether the commitments from the SQI-based billable
charges of the reference deal is copied to create the deal for the
entity (i.e. existing person, account, or prospect person). The valid
values are:
|
referPriceSw | Indicates whether the price list assignments and price assignments
of the reference deal is copied to create the deal for the entity
(i.e. existing person, account, or prospect person). The valid values
are:
|
includeChildHierarchyFlag | Indicates whether the child persons, grandchild persons,
and their accounts of the reference deal is included while creating
the deal for the entity (i.e. existing person, account, or prospect
person).. The valid values are:
|
division | Indicates the division to which the reference person belongs. |
dealComments | Displays information about the actions performed on the deal. |
sequenceNo | Displays the sequence number in which the action is performed on the deal. |
commentsDateTime | Displays the date and time when the action is performed on the deal. |
user | Displays the user who has performed the action on the deal. |
dealComments | Displays the details about the action performed on the deal. |
reasonCode | Displays the reason why the action is performed on the deal. |
modelcomments | Displays information about the actions performed on the deal version of the deal. |
sequenceNo | Displays the sequence number in which the action is performed on the deal version of the deal. |
commentsDateTime | Displays the date and time when the action is performed on the deal version of the deal. |
user | Displays the user who has performed the action on the deal version of the deal. |
modelComments | Displays the details about the action performed on the deal version of the deal. |
adhocRevenueCostDetails | Displays information about the adhoc revenue and cost of the deal. |
sequence | Displays the sequence number of the adhoc revenue or cost of the deal. |
revenueCostGroupFlag | Indicates the group to which the adhoc charge belongs. The
valid values are:
|
division | Indicates the division for which the adhoc charge is applicable. |
currency | Indicates the currency in which the adhoc charge is specified for the deal. |
amount | Displays the amount for the adhoc revenue or cost. Note: You
can even view the negative value in this attribute.
|
priceItem | Indicates the particular price item for which the adhoc charge is added. |
dealSimulationDetails | Displays the deal level, division level, and product level simulation details of the deal. |
dealFinancialSummaryDetails | Displays information about the financial summary at the deal level. |
approvalStatus | Indicates the current approval status of the financial summary
at the deal level.
|
originalDealFinancialSummary | Displays information about the financial summary at the deal level which is calculated using the original price list assignments and price assignments. |
revenue | Displays the revenue generated at the deal level from the original price list assignments and price assignments. |
cost | Displays the cost calculated at the deal level from the original price list assignments and price assignments. |
profit | Displays the profit in deal currency generated from the original price list assignments and price assignments at the deal level. |
profitabilityPercentage | Displays the profit generated in percentage (%) from the original price list assignments and price assignments at the deal level. |
proposedDealFinancialSummary | Displays information about the financial summary at the deal level which is calculated using the proposed price list assignments and price assignments. |
revenue | Displays the revenue generated at the deal level from the proposed price list assignments and price assignments. |
cost | Displays the cost calculated at the deal level from the proposed price list assignments and price assignments. |
profit | Displays the profit in deal currency generated from the proposed price list assignments and price assignments at the deal level. |
profitabilityPercentage | Displays the profit generated in percentage (%) from the proposed price list assignments and price assignments at the deal level. |
recommenedDealFinancialSummary | Displays information about the financial summary at the deal level which is calculated using the recommended price list assignments and price assignments. |
revenue | Displays the revenue generated at the deal level from the recommended price list assignments and price assignments. |
profit | Displays the profit in deal currency generated from the recommended price list assignments and price assignments at the deal level. |
profitabilityPercentage | Displays the profit in deal currency generated from the recommended price list assignments and price assignments at the deal level. |
profitVariationPercentage | Displays the difference in the original and the proposed profits at the deal level in percentage (%). |
divisionFinancialSummaryDetails | Displays information about the financial summary at the division level. |
division | Indicates the division for which the financial summary is displayed. |
approvalStatus | Indicates the current approval status of the financial summary
at the division level.
|
originalDivisionFinancialSummary | Displays information about the financial summary at the division level which is calculated using the original price list assignments and price assignments. |
revenue | Displays the revenue generated at the division level from the original price list assignments and price assignments. |
cost | Displays the cost calculated at the division level from the original price list assignments and price assignments. |
profit | Displays the profit in deal currency generated from the original price list assignments and price assignments at the division level. |
profitabilityPercentage | Displays the profit generated in percentage (%) from the original price list assignments and price assignments at the division level. |
proposedDivisionFinancialSummary | Displays information about the financial summary at the division level which is calculated using the proposed price list assignments and price assignments. |
revenue | Displays the revenue generated at the division level from the proposed price list assignments and price assignments. |
cost | Displays the cost calculated at the division level from the proposed price list assignments and price assignments. |
profit | Displays the profit in deal currency generated from the proposed price list assignments and price assignments at the division level. |
profitabilityPercentage | Displays the profit generated in percentage (%) from the proposed price list assignments and price assignments at the division level. |
recommenedDealFinancialSummary | Displays information about the financial summary at the division level which is calculated using the recommended price list assignments and price assignments. |
revenue | Displays the revenue generated at the division level from the recommended price list assignments and price assignments. |
profit | Displays the profit in deal currency generated from the recommended price list assignments and price assignments at the division level. |
profitabilityPercentage | Displays the profit in deal currency generated from the recommended price list assignments and price assignments at the division level. |
profitVariationPercentage | Displays the profit generated in percentage (%) from the recommended price list assignments and price assignments at the division level. |
productFinancialSummaryDetails | Displays information about the financial summary at the product level. |
approvalStatus | Indicates the current approval status of the financial summary
at the product level.
|
product | Indicates the product for which the financial summary is displayed. |
division | Indicates the division for which the product financial summary is displayed. |
originalProductFinancialSummary | Displays information about the financial summary at the product level which is calculated using the original price list assignments and price assignments. |
revenue | Displays the revenue generated at the product level from the original price list assignments and price assignments. |
cost | Displays the cost calculated at the product level from the original price list assignments and price assignments. |
profit | Displays the profit in deal currency generated from the original price list assignments and price assignments at the product level. |
profitabilityPercentage | Displays the profit generated in percentage (%) from the original price list assignments and price assignments at the product level. |
proposedProductDivisionFinancialSummary | Displays information about the financial summary at the product level which is calculated using the proposed price list assignments and price assignments for a particular division. |
revenue | Displays the revenue generated at the product level from the proposed price list assignments and price assignments. |
cost | Displays the cost calculated at the product level from the proposed price list assignments and price assignments. |
profit | Displays the profit in deal currency generated from the proposed price list assignments and price assignments at the product level. |
profitabilityPercentage | Displays the profit generated in percentage (%) from the proposed price list assignments and price assignments at the product level. |
recommenedDealFinancialSummary | Displays information about the financial summary at the product level which is calculated using the recommended price list assignments and price assignments. |
revenue | Displays the revenue generated at the product level from the recommended price list assignments and price assignments. |
profit | Displays the profit in deal currency generated from the recommended price list assignments and price assignments at the product level. |
profitabilityPercentage | Displays the profit in deal currency generated from the recommended price list assignments and price assignments at the product level. |
profitVariationPercentage | Displays the profit generated in percentage (%) from the recommended price list assignments and price assignments at the product level. |
hierarchySimulationDetails | Displays information about the financial summary at the entity level in the customer hierarchy. |
hierarchyDetails | Displays the details of the hierarchy. |
entityType | Displays the type of the entity for which the financial summary is displayed. |
entityId | Displays the entity (i.e. person or account) in the customer hierarchy for which the financial summary is displayed. |
entityIdentifierTyoe | Displays the identifier type using which the entity is created in the system. |
entityIdentifierValue | Displays the value of the entity identifier type. |
entityDivision | Indicates the division to which the entity belongs. |
parentEntityId | Displays the parent person to whom the entity (i.e. person or account) belongs in the customer hierarchy. |
parentEntityIdentifierType | Displays the identifier type using which the parent entity is created in the system. |
parentEntityIdentifierValue | Displays the value of the parent entity identifier type. |
parentEntityDivision | Indicates the division to which the parent entity belongs. |
status | Indicates the current approval status of the price list assignments and price assignments for the respective entity (i.e. person or account) in the customer hierarchy. |
revenueVariation | Displays the average revenue generated from the price assignment and commitments of the price items at the entity (i.e. person or account) level in the customer hierarchy. |
proposedRevenue | Displays the revenue generated at the entity (i.e. person or account) level from the proposed price assignment and commitments of the price items. |
proposedCost | Displays the cost calculated at the entity (i.e. person or account) level from the proposed price assignment and commitments of the price items. |
originalRevenue | Displays the revenue generated at the entity (i.e. person or account) level from the original price assignment and commitments of the price items. |
originalCost | Displays the cost calculated at the entity (i.e. person or account) level from the original price assignment and commitments of the price items. |
dealPricingAndCommitment | Displays information about the price assignment and commitments of the entities (i.e. person or account) in the customer hierarchy of the deal. |
pricingAndCommitmentsDetails | Displays the price assignment and commitment details of the entity (i.e. person or account) in the customer hierarchy of the deal. |
entityId | Displays the entity (i.e. person or account) 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:
|
entityIdentifierType | Indicates the identifier type using which the entity (i.e. person or account) is created in the system. |
entityIdentifierValue | Indicates the value of the identifier type using which the entity (i.e. person or account) is created in the system. |
entityDivision | Indicates the division to which the entity (i.e. person or account) belongs. |
pricingDetails | Displays the price assignment details of the entity (i.e. person or account) in the customer hierarchy of the deal. |
priceAsgnId | Displays the identification value of the price assignment for the entity (i.e. person or account) 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. |
cost | Displays the cost calculated at the price item level from the proposed price assignment and commitments of the price item. |
revenue | Displays the revenue generated from the proposed price assignment and commitments of the price item. |
averagePrice | Displays the average price of the price item as per the proposed price assignment and commitments of the price item. |
variation | Displays the variation between the original and proposed revenue in percentage (%) generated from the price assignment and commitments of the price item. |
pricingStatus | Indicates the current approval status of the price assignment of the price item. |
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 (i.e. person or account). |
endDate | Displays the date till when the price assignment of the price item is effective for the entity (i.e. person or account). |
isEligible | Indicates whether the eligibility criteria for the price
assignment is defined or not. The valid values are:
|
assignmentLevel | Indicates the level at which the pricing is defined for the
price item. The valid values are:
|
paTypeFlag | Indicates the type of price assignment. The valid values
are:
|
printIfZero | Indicates whether zero pricing is displayed or not. The valid
values are:
|
priceAssignCharacteristics | Displays the 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. |
parameterDetails | Displays the list of price item parameters which are used along with the price item for determining the price assignment. |
parameterCode | Indicates the pricing parameter which is associated with the price item. |
parameterValue | 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:
|
ignoreSw | Indicates whether transaction mapped to price item pricing
are considered for billing or not. The valid values are:
|
aggregateSw | Indicates whether aggregation is required while rating the
transactions mapped to the price item pricing before billing. The
valid values are:
|
scheduleCode | Indicates the transaction aggregation cycle. The valid values
are:
|
priceCompDetails | Displays the price component details of the rate component defined for the price item price assignment. |
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. |
displaySw | Indicates whether the price component is displayed in the
bill or not. The valid values are:
|
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:
|
priceCompSequenceNo | Displays the sequence number of the price component. |
priceCompTier | Displays the tiering criteria of the price component. |
tierSeqNum | Indicates the tiering sequence number. |
priceCriteria | Indicates the tiering criterion which is used in the tiering range. |
lowerLimit | Displays the lower limit of the pricing range. |
upperLimit | Displays the upper limit of the pricing range. |
priceCompParameterDetails | 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.
|
parameterCode | Indicates the parameter which is associated with the tiering criteria. |
parameterValue | 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.
|
sequenceNumber | Displays the order in which the pricing eligibility criteria is executed in the rule. |
lhsPriceParmCd | Displays the left hand side parameter which you want to use along with the price item for price determination. |
operator | Indicates the relational operator used to define the relation
between the parameter name and the parameter value. The valid values
are:
|
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.
|
rhsPriceParmCd | Displays the parameter against which you have compared the parameter (on the left hand side). |
rhsPriceParmVal | Displays the parameter value against which you have compared the parameter (on the left hand side). |
isTrueFlag | Indicates what should happen when the condition is true (satisfied).
The valid values are:
|
isFalseFlag | Indicates what should happen when the condition is false
(not satisfied). The valid values are:
|
isInsufficientFlag | Used to indicate what should happen when the data is insufficient.
The valid values are:
|
commitmentDetails | Displays the price items commitment details for the entity (i.e. 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 is used for calculating the price item pricing. |
sqiTypeFlg | Indicates the status of the service quantity identifier details for calculating the price item pricing. |
termsAndConditionsDetails | Displays the list of terms and conditions associated with the deal at the price item level. |
priceItemCode | Displays the price item to which the terms and conditions are associated. |
priceItemDescription | Displays the description of the price item. |
priceItemGroupCode | Displays the root level and/or non-root level hierarchy entity to which the price item belongs. |
priceItemGroupCodeDescription | Displays the description of the root level and/or non-root level hierarchy entity to which the price item belongs. |
parameterDetails | Displays the list of the parameters using which the price item pricing is defined in the system. |
parameterCode | Indicates the parameter which is associated with the price item. |
parameterValue | Displays the value of the parameter which is associated with the price item. |
termsAndConditionsList | Displays information about the terms and conditions associated with the price item. |
termsAndCondition | Indicates the term and condition which is associated with the price item. |
description | Displays the description of the term and condition. |
termsAndConditionText | Displays additional information of the term and condition. |
entitycharacteristics | Displays the list of the characteristics defined for the entities (i.e. person or account) in the deal. |
entityId | Displays the identification value of the entity (i.e. person or account) for which the characteristic is defined. |
entityType | Indicates the type of the entity. The valid values are:
|
entityIdentifierType | Indicates the identifier type using which the entity (i.e. person or account) is created in the system. |
entityIdentifierValue | Displays the value of the identifier type using which the entity (i.e. person or account) is created in the system. |
entityDivision | Indicates the division to which the entity (i.e. person or account) belongs. |
entityCharacteristicsList | Displays information about the characteristic defined for the entity (i.e. person or account). |
effectiveDate | Displays the date from when the characteristic is effective for the entity (i.e. person or account). |
characteristicType | Indicates the characteristic type. |
characteristicValue | Displays the value of the characteristic type. |
Related Topics
For more information on... | See... |
---|---|
Sample deal extraction request and response in the JSON format | Sample Deal Extraction Request and Response in the JSON Format |