Deal Creation, Modification, and View through Inbound Web Service

Oracle Revenue Management and Billing enables you to create and edit a deal through a web service. At a time, you can create or edit only one deal version of a deal. It also enables you to view the details of a deal version through a web service. You can send a request from the external system to do the following through an inbound web service:

  • Create a deal with or without using a reference and/or a deal template

  • Edit the details of a deal version

  • View the details of a deal version

  • Add a new deal version to a deal

  • Simulate a deal version

  • Send a deal version for approval

  • Approve a deal version

  • Return a deal version to the submitter

  • Finalize a deal version

  • Accept or reject a deal version

  • View the price items assigned to the existing customer or account for which the deal is created

  • Select the price items for which you want to inherit, override, or edit pricing and add commitments in the deal version

At a time, you can send a request for any one of the above activities. We have shipped the following two inbound web services in this release:

  • C1-Deal - This is a SOAP based web service. You can use this web service when you want to send the above requests with respect to deal in the XML format.

  • C1-DealREST - This is a REST based web service. You can use this web service when you want to send the above requests with respect to deal in the XML or JSON format.

Both these inbound web services call the C1-DealCreationUpdateIWS business service. This business service is used to do the following:

  • Create a deal with or without using a reference and/or a deal template - While creating a deal, you can specify the following details:

    • Entity (i.e. existing or prospect customer or account) for which you want to create the deal

    • Details of the customer, main customer (in case of account), or prospect, such as customer segment, customer tier, division, etc.

    • Basic details of the deal, such as simulation type, review frequency, deal and deal version description, price selection date, usage period, etc.

    • Template details in case you want to create the deal using a deal template

    • Characteristics and terms and conditions for the deal

    • Recommended products for the deal

    • Whether you want to refer another entity or deal for pricing and commitments

    To add a deal through the web service, you must set the action flag to ADD. On processing the request, the system creates the deal and its deal version in the PSML or DHRC status.

  • Edit the details of a deal version - While editing a deal version of a deal, you need to:

    • Specify the deal version ID or deal ID or deal identifier to determine the deal version that you want to edit

    • Set the action flag to UPD

    During the update operation, the system replaces the deal version data instead of editing it. Therefore, you should provide all details of the deal version including the data that you want to change.

  • View the details of a deal version - While viewing the details of a deal version, you need to:

    • Specify the deal version ID or deal ID or deal identifier to determine the deal version whose details you want to view

    • Set the action flag to READ

    On processing the request, the system displays the details of the deal and its deal version.

  • Add a new deal version to a deal - While adding a deal version to a deal, you need to:

    • Specify the deal version ID or deal ID or deal identifier to determine the deal in which you want to add the version

    • Specify the description for the deal version

    • Specify the method using which you want to create the deal version

    • Set the action flag to ADD and the operation flag to CRDV

    On processing the request, the system creates the deal version in the PSML or DHRC status.

  • Simulate a deal version - While simulating a deal version of a deal, you need to:

    • Specify the deal version ID or deal ID or deal identifier to determine the deal version that you want to simulate

    • Set the action flag to UPD and the operation flag to SMLD

    On processing the request, the status of the deal version is changed to SMLD or DSML. If the deal version is in the SMLD status, the system displays the deal level financial summary, division level financial summary (if any), and product level financial summary (if any) along with the hierarchy level simulation details.

  • Send a deal version for approval - While sending a deal version for approval, you need to:

    • Specify the deal version ID or deal ID or deal identifier to determine the deal version that you want to send for approval

    • Set the action flag to UPD and the operation flag to SNDP

    On processing the request, the system sends the deal version to the deal approval hierarchy. If the product and/or division level approval is required for the deal, the system sends the deal version to the product and/or division approval hierarchy before it goes to the deal approval hierarchy.

  • Approve a deal version - While approving a deal version, you need to:

    • Specify the deal version ID or deal ID or deal identifier to determine the deal version that you want to approve

    • Set the action flag to UPD and the operation flag to APPR

    On processing the request, the system either approves the deal version or sends the deal to the next level in the approval hierarchy. Only the approver at the respective level in the product, division, or deal approval hierarchy can approve the deal version of the deal.

  • Return the deal version to the submitter - While requesting the submitter to resubmit the deal version for approval, you need to:

    • Specify the deal version ID or deal ID or deal identifier to determine the deal version that you want to return to the submitter

    • Set the action flag to UPD and the operation flag to RETN

    On processing the request, the deal is resubmitted to the submitter to incorporate the changes requested by the approver.

  • Finalize a deal version - While finalizing a deal version, you need to:

    • Specify the deal version ID or deal ID or deal identifier to determine the deal version that you want to finalize

    • Set the action flag to UPD and the operation flag to FNAL

    On processing the request, the deal is finalized and its status is changed to FNAL.

  • Accept a deal version - While accepting a deal version, you need to:

    • Specify the deal version ID or deal ID or deal identifier to determine the deal version that you want to review

    • Set the action flag to UPD and the operation flag to ACPT

    • Specify the start date from when the deal version will be effective and end date (if it is a contracted deal) till when the deal version will be effective

    On processing the request, the status of the deal is changed to ACPT.

  • Reject a deal version - While rejecting a deal version, you need to:

    • Specify the deal version ID or deal ID or deal identifier to determine the deal version that you want to review

    • Set the action flag to UPD and the operation flag to REJC

    • Reason why you want to reject the deal version

    On processing the request, the status of the deal is changed to REJC.

  • Discard a deal version - While discarding a deal version, you need to:

    • Specify the deal version ID or deal ID or deal identifier to determine the deal that you want to discard

    • Set the action flag to UPD and the operation flag to DSCR

    On processing the request, the status of the deal is changed to DSCR.

  • View the price items assigned to the customer or account for which the deal is created - While viewing the price items assigned to the existing entity for which the deal is created, you need to:

    • Specify the deal version ID or deal ID or deal identifier to determine the deal whose details you want to view

    • Set the action flag to READ and the operation flag to PSEL

    On processing the request, the system lists all price items which are currently assigned to the entity using the respective pricing parameters. It also indicates whether any price item and pricing parameters combination is available in the deal version at the moment for defining the proposed pricing and commitments.

  • Select the price items for which you want to inherit, override, or edit pricing and add commitments in the deal version - While selecting the price items in a deal version, you need to:

    • Specify the deal version ID or deal ID or deal identifier to determine the deal version which you want to edit

    • Set the action flag to UPD and the operation flag to PSEL

    • Set the Include flag of the price item and pricing parameters combination to true

    On processing the request, the system enables you to define proposed pricing and commitments for the selected price item and pricing parameters combination.

If both the deal version and deal ID or deal identifier are given in the request, the system considers the deal version. However, if only the deal ID or deal identifier is given in the request, the system derives the deal version. Note that an error occurs when the given deal has multiple deal versions. For more information about the Deal Management functionality, refer to Oracle Revenue Management and Billing Banking User Guide.