C1-CreateHoldRequest Business Service
The Create Hold Request (C1-CreateHoldRequest) business service enables you to create a hold request for a single entity (i.e., for a particular person, account, or bill). In other words, you cannot include multiple entities in the same hold request. You can call this business service from an external system through an inbound web service. If you want to send the hold creation 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 creation 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 creation request, you need to specify the following details:
-
Hold request type, hold request start date, and hold request end date or hold days (which is used to calculate hold request end date if not specified).
-
Entity (i.e., Person, Account, or Bill) for which you want to create the hold request.
-
Hold reason and comments, if any.
-
Entity identifiers or entity ID when the entity is an account or a person, and the entity ID when the entity is a bill.
-
Hold entity and hold process end dates.
-
Business processes (i.e., Auto Pay, Bill Generation, Delinquency, Funding, Overdue, Refund) which you want to hold for the entity for the given duration.
-
Characteristics for the hold request, if required.
You must specify an active hold request type where the approval process is not configured for activation and release.
If you do not specify the hold request type, the system, by default, considers the hold request type specified in the Default Hold Request Type for IWS option type of the C1-HOLDSRCH feature configuration.
This business service allows you to create a future dated hold request but not a past dated hold request.
Even if you explicitly specify a value for the defer processing count in the hold request type, it is not considered by this business service while creating a hold request. The system will always create the hold request in the Active status.
On creating a hold request, the status of the hold request is set to Active. The start date of the hold entity and hold process is set to the hold request start date. If you do not specify the hold entity and/or hold process end dates, the system, by default, sets it to the hold request end date. While creating a hold request through an inbound web service, the system sets the creation mode of the hold request to Automatic.
Once the hold request is created through an inbound web service, the hold request ID is sent in the response along with its status. If an error occurs while creating the hold request, the system sends the error message in the response. The system enables you to track the hold creation response sent to the external system using the Inbound Web Service History feature.
For more information, see Inbound Web Service History.
Related Topics
| For more information on... | See... |
|---|---|
| Hold Creation Request in the XML Format | Hold Creation Request in the XML Format |
| Hold Creation Response in the XML Format | Hold Creation Response in the XML Format |
| Hold Creation Request in the JSON Format | Hold Creation Request in the JSON Format |
| Hold Creation Response in the JSON Format | Hold Creation Response in the JSON Format |
| Hold Creation Request and Response - Tags in XML Format | Hold Creation Request and Response - Tags in XML Format |
| Hold Creation Request and Response - Attribute/Value Pairs in JSON Format | Hold Creation Request and Response - Attribute/Value Pairs in JSON Format |
| Sample Hold Creation Request and Response in the XML Format | Sample Hold Creation Request and Response in the XML Format |
| Sample Hold Creation Request and Response in the JSON Format | Sample Hold Creation Request and Response in the JSON Format |
Parent Topic: Hold Request Creation, Modification, Release, and View Through Inbound Web Service