C1-UpdateHoldRequest Business Service

The Update Hold Request (C1-UpdateHoldRequest) business service enables you to edit an existing hold request which is in the Active status. You can call this business service from an external system through an inbound web service. If you want to send the hold update request in the XML and/or JSON format, you need to ensure that you create a REST based inbound web service in Oracle Revenue Management and Billing. However, if you want to send the hold update request in the XML format, you can create a SOAP or REST based inbound web service in Oracle Revenue Management and Billing.

While sending the hold update request, you need to specify the following details:

  • Hold Request ID

  • Hold Entity ID (i.e. person ID, account ID, or bill ID)

Through this service, you can edit the following details of an active hold request:

  • End date, comments, and characteristics of the hold request

  • End date of a single hold entity in the hold request

  • End date of multiple hold processes in the hold request

Note: At present, you can only update the end date of a single entity through a hold update request. If two or more entities are kept on hold through a hold request, you need to initiate a separate hold update request for each entity in order to update their respective end dates.

In addition, this service enables you to:

  • Add a New Hold Process to an Existing Hold Request - While adding a new process to an existing hold request, the system does the following:

    • Sets the hold process start date to the hold request start date.

    • If you do not specify the hold process end date, the system, by default, sets it to the hold request end date.

  • Define, Edit, or Remove a Characteristic from an Existing Hold Request - The system enables you to perform the following actions for a hold request characteristic:

    • UPDATE - Used when you want to add a new characteristic to the hold request or update the details of an existing characteristic of the hold request. The system first checks whether a characteristic with the given characteristic type and effective date combination exists for the hold request. If so, the system updates the existing characteristic of the hold request. However, if a characteristic does not exist with the given characteristic type and effective date combination for the hold request, the system creates a new characteristic for the hold request.

    • DELETE - Used when you want to delete an existing characteristic from the hold request.

Once the hold request is edited through an inbound web service, the hold request ID is sent in the response. If an error occurs while updating the hold request, the system sends the error message in the response. The system enables you to track the hold update response sent to the external system using the Inbound Web Service History feature.

For more information, see Inbound Web Service History.

Note: After updating the end date of a hold entity, you need to execute the Hold Request Monitor (C1-HLMON) batch. On executing the batch, the system will accordingly update the bill after date, postpone credit review until date, defer auto pay date, and hold refund until date, if required, for the respective entity.

Related Topics

For more information on... See...
Hold Update Request in the XML Format Hold Update Request in the XML Format
Hold Update Response in the XML Format Hold Update Response in the XML Format
Hold Update Request in the JSON Format Hold Update Request in the JSON Format
Hold Update Response in the JSON Format Hold Release Response in the JSON Format
Hold Update Request and Response - Tags in XML Format Hold Update Request and Response - Tags in XML Format
Hold Update Request and Response - Attribute/Value Pairs in JSON Format Hold Update Request and Response - Attribute/Value Pairs in JSON Format
Sample Hold Update Release Request and Response in the XML Format Sample Hold Update Request and Response in the XML Format
Sample Hold Update Release Request and Response in the JSON Format Sample Hold Update Request and Response in the JSON Format

Parent Topic: Hold Request Creation, Modification, Release, and View Through Inbound Web Service