Deal Update Request and Response - Attribute/Value Pairs in the JSON Format

Note: We recommend you to refer the topics Deal Update Request in the JSON Format and Deal Update Response 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 update request contains the following attributes:

Attribute Name Attribute Description Mandatory (Yes or No)
actionFlag Used to indicate that you want to create request to update a deal. The valid value is:

  • UPD

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 details of the deal operation. No
operationFlag Used to indicate that you want to create request that which operation you want to perform on a deal. The valid values are:

  • APPR

  • ACPT

  • REJC

  • FNAL

  • SMLD

  • SNDP

  • RETN

  • PSEL

  • CRDV

  • DSCR

    Note: You cannot specify the operationFlag attribute as DSCR if the status of the deal version is FORC, PROR, REJC, FNAL, or ACPT.
Note:

If you specify the value of actionFlag attribute as UPD and operationFlag attribute as SMLD, then, the deal version gets simulate.

If you specify the value of actionFlag attribute as UPD and operationFlag attribute as SNDP, then, the deal version is send for the approval.

If you specify the value of actionFlag attribute as UPD and operationFlag attribute as APPR, then, the deal version is approved or send to next level in the approval hierarchy.

If you specify the value of actionFlag attribute as UPD and operationFlag attribute as RETN, then, the submitter is requested to resubmit the deal version for the approval.

If you specify the value of actionFlag attribute as UPD and operationFlag attribute as FNAL, then, the deal version gets finalized.

If you specify the value of actionFlag attribute as UPD and operationFlag attribute as ACPT, then, the deal version is accepted.

If you specify the value of actionFlag attribute as UPD and operationFlag attribute as REJC, then, the deal version is rejected.

If you specify the value of actionFlag attribute as UPD and operationFlag attribute as DSCR, then, the deal version is discarded.

To select the price item for which you want to inherit, override, or edit pricing and commitments in the deal version you need to set the value of actionFlag attribute as UPD and operationFlag attribute as PSEL, and includeFlag of price item and pricing parameter as true.

If you specify the value of actionFlag attribute as UPD and operationFlag attribute as APPR, SNDP or RETN, then, the system will check the value of dealIdentifier and dealId.

If you specify the value of dealId as blank and specify the value of dealIdentifier then the system will fetch dealId and modelId.

If you specify the value of actionFlag attribute as UPD and operationFlag attribute as FNAL or REJC, then, the system will check value of dealIdentifier and dealId.

If you specify the value of dealId as blank and specify the value of dealIdentifier then the system will fetch dealId.

If you specify the value of actionFlag is UPD and operationFlag as APPR, SNDP, RETN, FNAL, ACPT, or REJC, then, the system will throw an error as multiple deal version exist for dealIdentifier or dealId.

 Yes (Conditional)
dealIdentifier Used to specify the deal identifier using which you want to update the deal in the system. Yes (Conditional)
Note: This data is required if the do not specify value of dealId attribute.
dealId Used to specify the deal for which you want to create the update request. Yes (Conditional)
Note: This data is required if the do not specify value of dealIdentifiertag.
modelId Used to specify the deal version for which you want to create the update request. Yes (Conditional)
Note: This data is required if the value of operation flag is APPR and multiple deal version exists in the system.
dealAcceptEffStartDate Used to specify the date from when the deal is effective for the existing or prospect person or account. Yes (Conditional)
Note: This data is required if the value of operationFlag is set toACPT.
dealAcceptEffEndDate Used to specify the date till when the deal is effective for the existing or prospect person or account. Yes (Conditional)
Note: This data is required if the value of operationFlag is set to ACPT.
comments Used to specify the information about accepting or rejecting the deal. Yes (Conditional)
Note: This data is required if the value of operationFlag is set toREJC.
rejectReasonCode Used to specify the deal rejectReasonCode which you want to reject. Yes (Conditional)
Note: This data is required if the value of operation flag is set to REJC.
dealVersionDescription Used to specify the deal version description. No
dealVersionCreationFlag Used to indicate the method using which you want to create a new deal version. The valid values are:

  • CVOC - Used to indicate that you want to copy the customer hierarchy without the pricing and commitment details from the current deal version to the new deal version.

  • CVWC - Used to indicate that you want to copy the customer hierarchy and pricing and commitment details from the current deal version to the new deal version.

  • FLHR - Used to indicate that you want to derive the latest customer hierarchy from the system.
    Note:

    In this case, you will have to select the price items, assign the required price lists to the entities, override or edit the required proposed pricing, and add commitments from scratch in the new deal version.

    Also, the system will include all the prospect persons and accounts associated with the customer in the customer hierarchy of the deal version.

 No
priceItemGroupSelection Used to specify the details of price item group selection. No
priceItemSelectionList Used to specify a list of price item selection. No
priceItemCode Used to specify the price item code which is associated with the deal that you want to update. Yes (Conditional)
Note: This data is required while updating the price item associated with the deal.
priceItemInfo Used to specify the information of the price item that you want to update. Yes (Conditional)
Note: This data is required while updating the price item associated with the deal.
parameterInfo Used to specify the information of the parameters which are associated with the price item. Yes (Conditional)
Note: This data is required while updating the price item associated with the deal.
assignmentLevel Used to indicate the level at which the price item pricing is defined in the person hierarchy. Yes (Conditional)
Note: This data is required while updating the price item associated with the deal.
hierarchyDetails Used to specify the details of the person hierarchy. Yes (Conditional)
Note: This data is required while updating the price item associated with the deal.
includeFlag Used to indicate the flag value of the price item pricing. The valid value are:

  • true

  • false

Note: You have to set the includeFlag of the price item and pricing as true.
 Yes (Conditional)
Note: This data is required while updating the price item associated with the deal.
dealDetails Used to specify the details for a deal. No
dealEntityDetails Used to specify the details of the entity for which you want to update the deal. No
personIdentifierType Used to indicate the identifier type of the existing person based on which you want to update the deal. Yes (Conditional)
Note: This data is required if you specify the personIdentifier attribute.
personIdentifier Used to specify the existing person identifier. Yes (Conditional)
Note: This data is required if you specify the personIdentifierType attribute.
personId Used to specify the existing person whose deal you want to update. Yes (Conditional)
Note: This data is required if you specify the personIdentifier attribute.
accountIdentifierType Used to indicate the identifier type of the existing person account based on which you want to update the deal. Yes (Conditional)
Note: This data is required if you specify the accountIdentifier attribute.
accountIdentifier Used to specify the existing person account identifier. Yes (Conditional)
Note: This data is required if you specify the accountIdentifierType attribute.
accountId Used to specify the existing person account whose deal you want to update. Yes (Conditional)
Note: This data is required if you do not specify the accountIdentifier attribute.
prsPerIdentifierType Used to indicate the identifier type of the prospect person based on which you want to update the deal. Yes (Conditional)
Note: This data is required if you specify the prsPerIdentifier attribute.
prsPerIdentifier Used to specify the prospect person identifier. Yes (Conditional)
Note: This data is required if you specify the prsPerIdentifierType attribute.
prospectPersonId Used to specify the prospect person whose deal you want to update. Yes (Conditional)
Note: This data is required if you do not specify the prsPerIdentifier attribute.
division Used to indicate the division to which the person belongs. Yes (Conditional)
Note: This data is required if you specify the personIdentifier and personIdentifierType attributes.
dealIdentifier Used to specify the deal identifier for which you want to update the deal. Yes (Conditional)
Note: This data is required if you do not specify the dealId or dealversionId attribute.
dealInformation Used to specify the information about the deal which you want to update for the entity. Yes
dealId Used to specify the deal for which you want to create the update request. Yes (Conditional)
Note: This data is required if you do not specify the dealIdentifier or dealversionId attribute.
modelId Used to specify the model for which you want to create the update request. No
dealEntityType Used to indicate the deal entity type for which you want to update the deal.

  • EPER

  • EACC

  • PRSP

Note:

If you specify the value of this attribute asEPER, then, you must specify the values for the personId, personIdentifierType, personIdentifier, and division attributes.

If you specify the value of this attribute as EPER, then, the system will fetch the details of accessGrp, division, customerSegment, and customerTier from the existing person.

If you specify the value of this attribute as EACC, then, you must specify the values for the accountId, accountIdentifierType, accountIdentifier, and division attributes.

If you specify the value of this attribute as EACC, then, the system will fetch the details of main personId from existing person's account and division, accessGrp, customerSegment, and customerTier from the existing person.

If you specify the value of this attribute as PRSP, then, you must specify the values for the prospectPersonId , prsPerIdentifierType, prsPerIdentifier, and division attributes.

If you specify the value of this attribute as PRSP, then, the system will fetch the details of the accessGrp, division, customerSegment and customerTier from the prospect person.

 Yes
customerSegment Used to indicate the business component to which the entity (i.e. the existing person or account, prospect person) belongs. The valid values are:

  • COMM

  • CORP

  • SME

 No
customerTier Used to indicate the customer tier to which the entity (i.e. the existing person or account, prospect person) belongs. No
division Used to indicate the division to which the entity (i.e. the existing person or account, prospect person) is associated.
Note:

You must specify a division which is already defined in the system.

 Yes
accessGrp Used to indicate the user groups who can view and edit the details of the entity.
Note: You must specify an accessGrp which is associated with the division to which the entity belongs.
 Yes
dealEntityId Used to specify the deal entity Id whose details you want to update.
contractedDealFlag Used to indicate that the change in the price item pricing from the price list does not affect the price item pricing offered in the deal created for an existing person, account or prospect person.

  • true

  • false

 Yes
currency Used to specify the currency in which you want to calculate the deal or division specific financial summary and profitability of the deal. Yes
dealTypeCode Used to indicate the deal type using which you want to create request to update the deal in the system. Yes
startDate Used to specify the date from when the deal is effective for the entity (i.e. the person, account, or prospect person). Yes
endDate Used to specify the date till when the deal is effective for the entity (i.e. the person, account, or prospect person). No
simulationTypeFlag Used to indicate the simulation type using which you want to analyze the cost, revenue, and profitability of the deal. The valid values are:

  • CUST

  • ACCT

  • DEAL

 Yes
reviewFrequency Used to indicate the timely monitoring of the deal usage as per the commitments made by the customer. No
dealDescription Used to specify the description for the deal. No
dealVersionDescription Used to specify the description for the deal version. No
dealFrequency Used to indicate the duration in which you want to simulate the deal for calculating the financial summary and profitability of the deal.

  • Biannually

  • Monthly

  • Quarterly

  • Yearly

 Yes
skipReferenceFlag Used to indicate whether you want to use a deal which is already created in the system as a reference for copying the pricing and commitments in the deal or not. The valid values are:

  • true

  • false

Note: By default, the value is set to false.
 No
priceSelectionDate Used to specify the date from when the price lists, pricing assignments, and product enrollments are effective for simulation. Yes
usagePeriod Used to indicate the period for which you want to aggregate the deal data to determine the scope of the deal. The valid values are:

  • biannually

  • monthly

  • quarterly

  • yearly

 Yes
includeHierarchyFlag Used to indicate whether you want to include the child persons, grandchild persons, and their accounts in the customer hierarchy while updating the deal. The valid values are:

  • true

  • false

Note:

If the entity is prospect person, then you have specify the value of includeHierarchyFlag totrue.

If you specify the value of includeHierarchyFlag attribute astrue and dealEntityType is set asACCT or DEAL, then, the system will throw an error.

If you specify the value of includeHierarchyFlag attribute as false and dealEntityType as PRSP, then, the system will throw an error.

 Yes (Conditional)
status Used to indicate the current status of the deal. The valid values are:

  • DRAFT

  • PSML

  • PFAP

  • SMLD

  • DSML

  • RFAP

Note:

You can update the deal only if the value of deal status is set as DRFT, PSML, PFAP, SMLD, DSML orRFAP.

If you specify the value of the deal status as DRFT, then, you cannot update the details of dealEntityType, customerSegment, customerTier, accessGrp, division, and templatedeal else the system will throw an error.

If you specify the value of the deal status as PSML, then, you cannot update the details of startDate, createdDate , contractedDealFlag, dealIdentifier, templateDealId, dealTypeCode, dealEntityCode, status, customerTier, customerSegment, accessGrp, division, currency, SimulationTypeFlag, priceSelectionDate, dealFrequency, usagePeriod, templateFlag, skipReferenceFlag or includeHierarchyFlag else the system will throw an error.

If you specify the value of the deal status as PFAP, SMLD, DSML or RFAPthen, you cannot update the details of dealInformation and dealCharacteristics.

If the deal status is set as DRFT, PSML, PFAP, SMLD, DSML or RFAP then, the termsAndCondition can be updated only one who creates the deal, else the system will throw an error.

If the deal is approved, then, you cannot update the dealInformation, dealCharacteristics, termsAndCondition, and dealProduct else the system will throw an error.
dealVersionStatus Used to indicate the current status of the deal version(model). No
templateFlag Use to indicate whether you want the deal to be used as a template while updating the other deals.

  • true

  • false

Note: The system will check whether the user has access to update the template deal.
 Yes (Conditional)
templateReferenceDetails Used to specify the details of the template reference of the deal. No
templateDealId Used to specify the particular deal whose details you want to use as a template for other deals.
Note:

If you do not specify the templateDealIdentifier or templateModelId attributes, you need to specify the templateDealId attribute.

If you specify the values of templateDealId, templateDealIdentifier, and templateModelId attributes and the value for copyUsageFlag, copyBasicDetailsFlag, and copyPricingFlag attributes is set asfalse, then, the system will throw an error. The value of copyUsageFlag,copyBasicDetailsFlag, or copyPricingFlag attribute should be set to true.

If you specify templateDealIdentifier or templateDealId attribute and there are multiple deal versions then the system will throw an error.

If the value of templateDealIdentifier or templateDealId attribute is not found in the system then it will throw an error.

 Yes (Conditional)
Note: This data is required while specifying the template deal.
templateDealIdentifier Used to specify the deal identifier whose details you want to use as a template for other deals.
Note: If you do not specify the templateDealId or templateModelId attribute, you need to specify the templateDealIdentifier attribute.
 Yes (Conditional)
Note: This data is required while specifying the template deal.
templateModelId Used to specify the template deal version whose details you want to use as a template for other deals.
Note: If you do not specify the templateDealId or templateDealIdentifier attribute, you need to specify the templateModelId attribute.
 Yes (Conditional)
Note: This data is required while specifying the template deal.
copyBasicDetailsFlag Used to indicate whether you want to use basic details of the deal to update a deal. The valid values are:

  • true

  • false

Note: If you specify the templateDealId or templateDealIdentifier or templateModelId attributes, you need to set the value of the copyBasicDetailsFlag attribute.
 Yes (Conditional)
Note: This data is required while specifying the template deal.
copyPricingFlag Used to indicate whether you want to use pricing details of the deal to update a deal. The valid values are:

  • true

  • false

Note: If you specify the value for templateDealId or templateDealIdentifier or templateModelId attributes, you need to set the value of the copyPricingFlag attribute.
 Yes (Conditional)
Note: This data is required while specifying the template deal.
copyUsageFlag Used to indicate whether you want to use usage details of the deal to update a deal. The valid values are:

  • true

  • false

Note:

If you specify the value for templateDealId or templateDealIdentifier or templateModelId attributes, you need to set the value of the copyUsageFlag attribute.

If the templateDealId, templateDealIdentifier, and templateModelId is entered with copyUsageFlag value as true, then system will copy the dealinformation, dealproducts, dealTermsAndConditionsDetails, and dealCharacteristics from the deal.

If you specify the value for dealinformation attribute, then, it overrides the value of the template dealinformation .

If you specify the value for dealCharacteristics, dealTermsAndConditionsDetails, and dealproducts, then, it will add the value along with template dealCharacteristics, dealTermsAndConditionsDetails, and dealproducts.

 Yes (Conditional)
Note: This data is required while specifying the template deal.
dealCharacteristics Used to specify a list of characteristics of the deal. No
characteristicType Used to indicate the characteristic type. Yes (Conditional)
Note: This data is required while defining a characteristic for the deal.
effectiveDate Used to specify the date from when the characteristic is effective for the deal. Yes (Conditional)
Note: This data is required while defining a characteristic for the deal.
characteristicValue Used to specify the value for the characteristic type. Yes (Conditional)
Note: This data is required while defining a characteristic for the deal.
dealTermsAndConditionsDetails Used to specify the details of the terms and conditions of the deal. No
termsAndConditionsList Used to specify a list of the terms and conditions of the deal. No
description Used to specify the description of the terms and conditions of the deal. No
termsAndCondition Used to indicate the terms and conditions which you want to associate with the deal.
Note: If you do not specify the value in the termsAndCondition attribute, then, the system will throw an error.
 Yes (Conditional)
Note: This field is required while associating terms and conditions with a deal.
termsAndConditionText Used to specify the description of terms and conditions for the deal. Yes (Conditional)
Note: This field is required while associating terms and conditions with a deal.
adhocTermsAndCondition Used to indicate the adhoc terms and conditions which you want to associate with the deal. No
productDetailsList Used to specify a list of product details of the deal. No
productCode Used to specify the product code. No
referenceDetails Used to specify the details of the deal that you want to use as reference to update the deal. No
referenceTypeFlg Used to indicate the reference type of the deal that you want to use as reference to update the deal for the entity. The valid value is:

  • RPER

  • RACC

  • RDEL

Note: If you specify the value in the skipReferenceFlag as false, then, you need to specify the value in the referenceTypeFlg attribute.
Yes (Conditional)
Note: This data is required while specifying the reference deal.
refPersonIdentifierType Used to specify the reference person identifier type based on which you want to update the deal for the entity.
Note: If you specify the value in the referenceTypeFlg attribute as RPER, then, you need to specify the refPersonIdentifierType attribute.
Yes (Conditional)
Note: This data is required while specifying the reference deal of the person.
refPersonIdentifier Used to specify the value of the reference person identifier type.
Note: If you specify the value in the referenceTypeFlg attribute as RPER, then, you need to specify the refPersonIdentifier attribute.
Yes (Conditional)
Note: This data is required while specifying the reference deal of the person.
referPersonId Used to specify the reference person using which you want to update the deal.
Note: If you specify the value in the referenceTypeFlg attribute as RPER, then, you need to specify the referPersonId attribute.
Yes (Conditional)
Note: This data is required while specifying the reference deal of the person.
refAccountIdentifierType Used to specify the reference account identifier type based on which you want to update the deal for the entity.
Note: If you specify the value in the referenceTypeFlg attribute as RACC, then, you need to specify the refAccountIdentifierType attribute.
Yes (Conditional)
Note: This data is required while specifying the reference deal of the person account.
refAccountIdentifier Used to specify the value of the reference account identifier type.
Note: If you specify the value in the referenceTypeFlg attribute as RACC, then, you need to specify the refAccountIdentifier attribute.
Yes (Conditional)
Note: This data is required while specifying the reference deal of the person account.
referAccountId Used to specify the reference account using which you want to update the deal.
Note: If you specify the value in the referenceTypeFlg attribute as RACC, then, you need to specify the referAccountId attribute.
Yes (Conditional)
Note: This data is required while specifying the reference deal of the person account.
referDealIdentifier Used to specify the value of the reference deal identifier type.
Note: If you specify the value in the referenceTypeFlg attribute as RDEL, then, you need to specify the referDealIdentifier attribute.
Yes (Conditional)
Note: This data is required while specifying the reference deal.
referenceDealId Used to specify the reference deal using which you want to update the deal.
Note:

If you specify the value in thereferenceTypeFlg attribute as RDEL, then, you need to specify the referenceDealId attribute.

If you do not specify the value in thereferenceDealId, referDealIdentifier, and referenceModelId attributes, then, the system will throw an error.

If you specify the values in thereferenceDealId, referDealIdentifier, and referenceModelId attributes, then, the system will check whether the values are valid or not.

 Yes (Conditional)
Note: This data is required while specifying the reference deal.
referenceModelId Used to specify the reference deal version using which you want to update the deal.
Note: If you specify the value in the referenceTypeFlg attribute as RDEL, then, you need to specify the referenceModelId attribute.
Yes (Conditional)
Note: This data is required while specifying the reference deal.
referUsageSw Used to indicate whether you want to use reference usage details to update the deal.

  • true

  • false

Note:

By default, the value is set to false.

You need to specify the value of either referUsageSw or referPriceSw as true.

 Yes (Conditional)
Note: This data is required while specifying the reference deal.
referPriceSw Used to indicate whether you want to use reference pricing details to update the deal.

  • true

  • false

Note:

By default, the value is set to false.

You need to specify the value of either referUsageSw or referPriceSw as true.

 Yes (Conditional)
Note: This data is required while specifying the reference deal.
includeChildHierarchy Used to indicate whether you want to add child hierarchy in the deal of the person.

  • true

  • false

Note: By default, the value is set to false.
 Yes (Conditional)
division

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

Attribute Name Attribute Description
dealResponse Indicates whether the deal update request is successfully processed or not.
message Displays the message of successful deal update.
dealId Displays the deal ID.
modelId Displays the model ID.
createdDate Displays the date when the deal is created.
acceptanceDate Displays the date when the deal is accepted.
finalizedDate Displays the date when the deal is finalized.
effectiveStartDate Displays the date from when the deal is effective.
effectiveEndDate Displays the date till when the deal is effective.
reviewedDate Displays the date when the deal is reviewed.
dealSimulationDetails Displays the simulation details of the deal.
dealfinancialsummarylist Displays a list of 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 the summary of the original financial summary at the deal level.
revenue Displays the original revenue generated from the price item pricing and price assignments at the deal level.
cost Displays the original cost calculated at the deal level.
profit Displays the original profit in deal currency generated from the price item pricing and price assignments at the deal level. It is calculated using the following formula:

Profit = Revenue - Cost
profitabilityPercentage Displays the original profit created in percentage at the deal level from the price item pricing and price assignments. It is calculated using the following formula:

Profitability Percentage = ( Revenue - Cost)*100/ Revenue
proposedDealFinancialSummary Displays the summary of the proposed financial at the deal level.
revenue Displays the proposed revenue generated from the price item pricing and price assignments at the deal level.
cost Displays the proposed cost calculated at the deal level.
profit Displays the proposed profit in deal currency generated from the price item pricing and price assignments at the deal level. It is calculated using the following formula:

Profit = Revenue - Cost
profitabilityPercentage Displays the proposed profit created in percentage at the deal level from the price item pricing and price assignments. It is calculated using the following formula:

Profitability Percentage= ( Revenue - Cost)*100/ Revenue
recommenedDealFinancialSummary Displays the summary of the recommended financial at the deal level.
revenue Displays the recommended revenue generated from the price item pricing and price assignments at the deal level.
profit Displays the recommended profit in deal currency generated from the price item pricing and price assignments at the deal level. It is calculated using the following formula:

Profit = Revenue - Cost
profitabilityPercentage Displays the recommended profit created in percentage at the deal level from the price item pricing and price assignments. It is calculated using the following formula:

Profitability Percentage = ( Revenue - Cost)*100/ Revenue
profitVariationPercentage Displays the difference between the original profit and proposed profit in percentage at the recommend deal level from the price item pricing and price assignments.
divisionFinancialSummaryDetails Displays the summary details of the financial at the division level.
division Displays the division associated with the deal.
approvalStatus Indicates the current approval status of the financial summary at the division level.

  • APPR

  • EROR

  • INIT

  • UNAP
originalDivisionFinancialSummary Displays the summary of the original financial at the division level.
revenue Displays the original revenue generated from the price item pricing and price assignments at the division level.
cost Displays the original cost calculated at the division level.
profit Displays the original profit in deal currency generated from the price item pricing and price assignments at the division level. It is calculated using the following formula:

Profit = Revenue - Cost
profitabilityPercentage Displays the original profit created in percentage at the division level from the price item pricing and price assignments. It is calculated using the following formula:

Profitability Percentage = ( Revenue - Cost)*100/ Revenue
proposedDivisionFinancialSummary Displays the summary of the proposed financial at the division level.
revenue Displays the proposed revenue generated from the price item pricing and price assignments at the division level.
cost Displays the proposed cost calculated at the proposed level.
profit Displays the proposed profit in deal currency generated from the price item pricing and price assignments at the division level. It is calculated using the following formula:

Profit = Revenue - Cost
profitabilityPercentage Displays the proposed profit created in percentage at the division level from the price item pricing and price assignments. It is calculated using the following formula:

Profitability Percentage = ( Revenue - Cost)*100/ Revenue
recommenedDealFinancialSummary Displays the summary of the recommended financial at the deal level.
revenue Displays the recommended revenue generated from the price item pricing and price assignments at the deal level.
cost Displays the recommended cost calculated at the deal level.
profit Displays the recommended profit in deal currency generated from the price item pricing and price assignments at the deal level. It is calculated using the following formula:

Profit = Revenue - Cost
profitabilityPercentage Displays the recommended profit created in percentage at the deal level from the price item pricing and price assignments. It is calculated using the following formula:

Profitability Percentage= ( Revenue - Cost)*100/ Revenue
profitVariationPercentage Displays the difference between the recommended profit and proposed profit in percentage. at the division level from the price item pricing and price assignments.
productFinancialSummaryDetails Displays the summary details of the financial at the product level.
approvalStatus Indicates the current approval status of the financial summary at the product level.

  • APPR

  • EROR

  • INIT

  • UNAP
product Displays the product.
division Indicates the division for which the product financial summary is displayed.
originalProductFinancialSummary Displays the summary of the original financial at the product level.
revenue Displays the original revenue generated from the price item pricing and price assignments at the product level.
cost Displays the original cost calculated at the product level.
profit Displays the original profit in deal currency generated from the price item pricing and price assignments at the product level. It is calculated using the following formula:

Profit = Revenue - Cost
profitabilityPercentage Displays the original profit created in percentage at the product level from the price item pricing and price assignments. It is calculated using the following formula:

Profitability Percentage = ( Revenue - Cost)*100/ Revenue
proposedProductDivisionFinancialSummary Displays the summary of the financial at the proposed product division level.
revenue Displays the revenue generated from the price item pricing and price assignments at the proposed product division level.
cost Displays the cost calculated at the proposed product division level.
profit Displays the profit in deal currency generated from the price item pricing and price assignments at the proposed product division level. It is calculated using the following formula:

Profit = Revenue - Cost
profitabilityPercentage Displays the profit created in percentage at the proposed product division level from the price item pricing and price assignments. It is calculated using the following formula:

Profitability Percentage= ( Revenue - Cost)*100/ Revenue
recommenedDealFinancialSummary Displays the summary of the financial at the recommend deal level.
revenue Displays the revenue generated from the price item pricing and price assignments at the recommend deal level.
cost Displays the cost calculated at the recommend deal level.
profit Displays the profit in deal currency generated from the price item pricing and price assignments at the recommend deal division level. It is calculated using the following formula:

Profit = Revenue - Cost
profitabilityPercentage Displays the profit created in percentage at the recommend deal level from the price item pricing and price assignments. It is calculated using the following formula:

Profitability Percentage= ( Revenue - Cost)*100/ Revenue
profitVariationPercentage Displays the difference between the original profit and proposed profit in percentage. at the recommend deal level from the price item pricing and price assignments.
hierarchySimulationDetails Displays the details of the hierarchy simulation.
entityType Displays the entity type.
entityId Displays the entity Id of the child.
parentEntityId Displays the entity Id of the parent.
status Indicates the status of the deal.
revenueVariation Displays the average revenue generated from a person or account.
proposedRevenue Displays the revenue generated from the proposed price item pricing and commitments.
proposedCost Displays the overall cost of the proposed price item based on the usage.
originalRevenue Displays the revenue generated through the original price item pricing and commitments.
originalCost Displays the overall cost of the original price item based on the usage.

Related Topics

For more information on... See...
Sample deal update request and response in the JSON format Sample Deal Update Request and Response in the JSON Format
Sample deal version creation request and response in the JSON format Sample Deal Version Creation Request and Response in the JSON Format
Sample deal simulation request and response in the JSON format Sample Deal Simulation Request and Response in the JSON Format
Sample deal submission for approval request and response in the JSON format Sample Deal Submission for Approval Request and Response in the JSON Format
Sample deal approval request and response in the JSON format Sample Deal Approval Request and Response in the JSON Format
Sample deal return to submitter request and response in the JSON format Sample Deal Return to Submitter Request and Response in the JSON Format
Sample deal finalization request and response in the JSON format Sample Deal Finalization Request and Response in the JSON Format
Sample deal acceptance request and response in the JSON format Sample Deal Acceptance Request and Response in the JSON Format
Sample deal rejection request and response in the JSON format Sample Deal Rejection Request and Response in the JSON Format
Sample deal discard request and response in the JSON format Sample Deal Discard Request and Response in the JSON Format
Sample price item selection request and response in the JSON format Sample Price Item Selection Request and Response in the JSON Format