Deal View Request and Response - Attibute/Value Pairs in the JSON Format

Note: We recommend you to refer the topics Deal View Request in the JSON Format andDeal View Request in the JSON Format in parallel while understanding the below mentioned attributes. This will help you to understand how the attributes are structured in the JSON format.

Before calling the C1-DealCreationUpdateIWS business service through an inbound web service, you need to ensure that the deal view request contains the following attributes:

Attribute Name Attribute Description Mandatory (Yes or No)
actionFlag Used to indicate that you want to create request to view the deal details of an entity (i.e. existing person, account, or prospect person). The valid value is:

  • READ

Note: If you do not specify the value in this attribute, by default, the system considers it as an ADD action.
 Yes
dealOperation Used to specify the operation that you want to perform while viewing the deal details.
Note: You need to specify the dealOperation attribute only when you want to view the price items using which the deal is simulated.
 No
operationFlag Used to indicate that you want to create request to view the price items offered in the deal. The valid value is:

  • PSEL

 Yes (Conditional)
Note: This data is required for viewing the price items offered in the deal.
dealIdentifier Used to specify the primary identifier using which the deal is created in the system.
Note:

If you specify the dealIdentifier attribute, you need not specify the dealId or the modelId tags.

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 for viewing the price items offered in the deal.
dealId Used to specify the deal whose price items you want to view.
Note:

If you specify the dealId attribute, you need not specify the dealIdentifier or the modelId tags.

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 for viewing the price items offered in the deal.
modelId Used to specify the deal version whose price items you want to view.
Note:

If you specify the modelId attribute, you need not specify the dealIdentifier or the dealId tags.

 Yes (Conditional)
Note: This data is required for viewing the price items offered in the deal.
dealDetails Used to specify the details of the deal.
Note: You need to specify the dealDetails attribute only when you want to view the deal details other than the price items offered in the deal (i.e. when you do not specify the dealOperation attribute).
 No
dealIdentifier Used to specify the primary identifier using which the deal is created in the system.
Note:

If you specify the dealIdentifier attribute, you need not specify the dealId or the modelId tags.

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 for viewing the deal details except the price items offered in the deal.
dealId Used to specify the deal whose details you want to view.
Note:

If you specify the dealId attribute, you need not specify the dealIdentifier or the modelId tags.

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 for viewing the deal details except the price items offered in the deal.
modelId Used to specify the deal version whose details you want to view.
Note:

If you specify the modelId attribute, you need not specify the dealIdentifier or the dealId tags.

 Yes (Conditional)
Note: This data is required for viewing the deal details except the price items offered in the deal.

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

Attribute Name Attribute Description
dealResponse Indicates whether the deal view request is successfully processed or not.
message Displays the message generated for the deal response.
dealAcceptEffStartDate Displays the date when the deal is accepted in the system.
Note: The data in this attribute appears only when the deal is accepted in the system.
dealAcceptEffEndDate Displays the date till when you can finalize the deal in the system.
Note: The data in this attribute appears only when the deal is accepted in the system and awaiting finalization.
comments Displays information about deal acceptance or rejection.
rejectReasonCode Displays the reason why the deal is rejected in the system.
dealVersionDescription Displays description of the deal version created for the deal.
dealVersionCreationFlag Indicates the information using which the deal version is created. The valid values are:

  • CVOC - Indicates that the deal version is created without copying the changes done in the current deal.

  • CVWC - Indicates that the deal version is created by copying the changes done in the current deal.

  • FLHR - Indicates that the deal version is created by using the latest hierarchy of the entity from the system for which the current deal is created.
priceItemGroupSelection Displays the list of price items offered in the deal.
Note: The data in this attribute appears only when you are viewing the price items offered in the deal (i.e. when the value in the operationFlag attribute is set to PSEL).
priceItemSelectionList Displays information about the price item offered in the deal.
Note: The data in this attribute appears only when you are viewing the price items offered in the deal (i.e. when the value in the operationFlag attribute is set to PSEL).
priceItemCode Displays the price item.
Note: The data in this attribute appears only when you are viewing the price items offered in the deal (i.e. when the value in the operationFlag attribute is set to PSEL).
priceItemInfo Displays the concatenated string of information about the price item.
Note: The data in this attribute appears only when you are viewing the price items offered in the deal (i.e. when the value in the operationFlag attribute is set to PSEL).
parameterInfo Displays the parameters using which the pricing is defined for the price item.
Note: The data in this attribute appears only when you are viewing the price items offered in the deal (i.e. when the value in the operationFlag attribute is set to PSEL).
assignmentLevel Indicates the level at which the price item pricing is defined in the entity (i.e. exiting person, account, or prospect person) hierarchy. The valid values are:

  • Account Agreed - Indicates price item pricing is agreed for the account.

  • Account Price List - Indicates price item pricing is defined in the price list which is assigned to the account.

  • Account Inherited Price List - Indicates price item pricing is inherited from the parent price list hierarchy defined for the price list which is assigned to the account.

  • Customer Agreed - Indicates price item pricing is agreed for the main customer in the customer hierarchy.

  • Customer Price List - Indicates price item pricing is defined in the price list which is assigned to the main customer.

  • Default Price List - Indicates price item pricing defined in the price list is available in the default price list.

  • Global Price List - Indicates price item pricing defined in the price list is available in the global price list.

  • Customer Inherited Price List - Indicates price item pricing is inherited from the parent price list hierarchy defined for the price list which is assigned to the main customer.

  • Parent Customer Agreed - Indicates price item pricing is agreed for the parent customer in the customer hierarchy.

  • Parent Customer Price List - Indicates price item pricing is defined in the price list which is assigned to the parent customer.

  • Parent Customer Inherited Price List - Indicates price item pricing is inherited from the parent price list hierarchy defined for the price list which is assigned to the parent customer.

  • Product Default Price List - Indicates product defined in the price list is available in the default price list.

Note: The data in this attribute appears only when you are viewing the price items offered in the deal (i.e. when the value in the operationFlag attribute is set to PSEL).
hierarchyDetails Displays the root level and/or non-root level hierarchy entities to which the price item belongs.
Note: The data in this attribute appears only when you are viewing the price items offered in the deal (i.e. when the value in the operationFlag attribute is set to PSEL).
includeFlag Indicates whether the price item is included in the deal for simulation. The valid values are:

  • true

  • false

Note: The data in this attribute appears only when you are viewing the price items offered in the deal (i.e. when the value in the operationFlag attribute is set to PSEL).
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 specified in the dealEntityType attribute is EPER.
personIdentifier Displays the value of the person identifier type.
Note: The value in this attribute appears only when the value specified in the dealEntityType attribute is EPER.
personId Displays the existing person for whom the deal is created in the system.
Note: The value in this attribute appears only when the value specified in 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 specified in 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 specified in 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 specified in 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 specified in 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 specified in 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 specified in 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 (,).
modelId Displays the identification value of the deal version.
dealEntityType Indicates the type of entity for which the deal is created in the system. The valid values are:

  • EPER - Indicates that the deal is created for an existing person.

  • EACC - Indicates that the deal is created for an existing account.

  • PRSP - Indicates that the deal is created for a prospect person.
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 entity (i.e. existing person, account, or prospect person) belongs.
accessGrp Indicates the user group who can view and edit the details of the entity (i.e. existing person, account, or prospect person).
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:

  • true

  • false
currency Indicates the currency in which you want to calculate the deal level, division level, or product level financial summary and profitability of the deal.
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. existing person, account, or prospect person).
endDate Displays the date till when the deal is effective for the entity (i.e. existing person, account, or prospect person).
simulationTypeFlag Indicates the simulation type using which you want to analyze the cost, revenue, and profitability of the deal. The valid values are:

  • CUST

  • ACCT

  • DEAL
reviewFrequency Indicates the timely monitoring of the deal usage as per the commitments made by the customer. The valid values are:

  • 6 - Used to indicate that you want to monitor the deal usage biannually.

  • 12 - Used to indicate that you want to monitor the deal usage annually.

  • 24 - Used to indicate that you want to monitor the deal usage in every two years.
dealDescription Displays the description for the deal.
dealVersionDescription Displays the description for the deal version.
dealFrequency Indicates the duration in which you want to simulate the deal for calculating the financial summary and profitability of the deal. The valid values are:

  • 1 - Used to indicate that you want to simulate the deal every month

  • 3 - Used to indicate that you want to simulate the deal quarterly

  • 6 - Used to indicate that you want to simulate the deal biannually

  • 12 - Used to indicate that you want to simulate the deal annually
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:

  • true

  • false
priceSelectionDate Displays the date from when the price lists, pricing assignments, and product enrollments are effective for simulation.
usagePeriod Indicates the period for which you want to aggregate the deal data to determine the scope of the deal. The valid values are:

  • 1 - Used to indicate that you want to aggregate the deal data every month

  • 3 - Used to indicate that you want to aggregate the deal data quarterly

  • 6 - Used to indicate that you want to aggregate the deal data biannually

  • 12 - Used to indicate that you want to aggregate the deal data annually
includeHierarchyFlag Indicates whether the child persons, grandchild persons, and their accounts in the customer hierarchy are included in the deal or not. The valid values are:

  • true

  • false
templateFlag Indicates whether the deal is used as a template while searching references for other deals. The valid values are:

  • true

  • false
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 from the template deal are copied to create the deal or not. The valid values are:

  • true

  • false
copyPricingFlag Indicates whether the price list assignments and price assignments from the template deal are copied to create the deal or not. The valid values are:

  • true

  • false
copyUsageFlag Indicates whether the commitments from the SQI-based billable charges from the template deal are copied to create the deal or not. The valid values are:

  • true

  • false
dealCharacteristics Displays the list of characteristics of the deal.
characteristicType Indicates the characteristic type.
effectiveDate Displays the date from when the characteristic is effective for the deal.
characteristicValue Displays the value of the characteristic type.
dealTermsAndConditionsDetails Displays the list of terms and conditions that are associated with the deal.
termsAndConditionsList Displays the terms and conditions of the deal.
description Displays the description of the terms and conditions.
termsAndCondition Indicates the term and condition which is associated with the deal.
termsAndConditionText Displays additional information about the term and condition.
adhocTermsAndCondition Displays the adhoc terms and conditions associated with the deal.
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 in the system.
referenceTypeFlg Indicates the type of the reference deal using which the deal is created in the system. The valid values are:

  • RPER - Indicates that the deal is created by using the deal of an existing person as a reference.

  • RACC - Indicates that the deal is created by using the deal of an existing account as a reference.

  • RDEL - Indicates that the deal is created by using an existing deal as a reference.
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 specified in 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 specified in 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 specified in 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 specified in 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 specified in 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 specified in 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 specified in 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 specified in 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 specified in 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. The valid values are:

  • true

  • false
referPriceSw Indicates whether the price list assignments and price assignments of the reference deal is copied to create the deal. The valid values are:

  • true

  • false
includeChildHierarchy Indicates whether the child persons, grandchild persons, and their accounts of the reference deal is included while creating the deal. The valid values are:

  • true

  • false
dealSimulationDetails Displays the deal level, division level, and product level simulation details of the deal.
dealfinancialsummarylist Displays information about the financial summary at the deal level.
approvalStatus Indicates the current approval status of the financial summary at the deal level.

  • APPR

  • EROR

  • INIT

  • UNAP
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 cost calculated at the deal level from the recommended price list assignments and price assignments.
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.

  • APPR

  • EROR

  • INIT

  • UNAP
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.
cost Displays the cost calculated 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 generated in percentage (%) from the recommended price list assignments and price assignments at the division level.
profitVariationPercentage Displays the difference in the original and the proposed profits at the division level in percentage (%).
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.

  • APPR

  • EROR

  • INIT

  • UNAP
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.
cost Displays the cost calculated 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 generated in percentage (%) from the recommended price list assignments and price assignments at the product level.
profitVariationPercentage Displays the difference in the original and the proposed profits at the product level in percentage (%).
hierarchySimulationDetails Displays information about the financial summary at the entity level in the customer 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.
parentEntityId Displays the parent person to whom the entity (i.e. person or account) belongs in the customer hierarchy.
status Indicates the approval status of the price assignments for the respective entity (i.e. person or account).
revenueVariation Displays the difference in the original and the proposed revenues at the entity level in percentage (%).
proposedRevenue Displays the revenue generated at the entity level from the proposed price list assignments and price assignments.
proposedCost Displays the cost calculated at the entity level from the proposed price list assignments and price assignments.
originalRevenue Displays the revenue generated at the entity level from the original price list assignments and price assignments.
originalCost Displays the cost calculated at the entity level from the proposed price list assignments and price assignments.

Related Topics

For more information on... See...
Sample deal view request and response in the JSON format Sample Deal View Request Response in JSON Format
Sample price item selection view request and response in the JSON format Sample Price Item Selection View Request and Response in the JSON Format