AutoPay Add/Update, Delete, and View Through Inbound Web Service
Oracle Revenue Management and Billing enables you to define, edit, delete, and view auto pay instructions of an account through a web service. You can send the auto pay addition/modification, auto pay deletion, or auto pay view request from the external system through an inbound web service. The following three business services are shipped with the product to support different auto pay instruction operations:
| Business Service | Description |
|---|---|
| C1-AddUpdateAutoPayService |
Used to define or edit an auto pay instruction of an account. While sending the auto pay addition/modification request, you need to specify either of the following:
On processing the auto pay addition/modification request, the system first searches whether the auto pay instruction already exists for the account in the system. If so, the system edits the existing auto pay instruction of the account. If the auto pay instruction does not exist for the account, the system adds the auto pay instruction for the account. Note: The system searches for an auto pay instruction
either using the auto pay ID or using the start date, auto pay source,
auto pay route type, priority, and external account number combination.
The system enables you to define or edit an auto pay instruction of an account through the web service when the Rule Based Auto Pay option is not selected for the account. The approval workflow process is supported through the web service when you create or edit one auto pay instruction for an account and not when you create or edit multiple auto pay instructions or split auto pay instruction for an account. You can also create split auto pay instructions for an account through the web service. However, you need to ensure that split auto pay instructions with the same start date, end date, and priority computes to 100% in the request. For more information, see C1-AddUpdateAutoPay Business Service |
| C1-DeleteAutoPayService |
Used to delete an auto pay instruction of an account. While sending the auto pay deletion request, you need to specify either of the following:
On processing the auto pay deletion request, the system deletes an auto pay instruction of the account. If you specify the account details, the system deletes all auto pay instructions of the account. And, if you specify the auto pay ID, the system deletes the respective auto pay instruction of the account. Note that the system deletes an auto pay instruction of the account when it is not yet used in the system. For more information, see C1-DeleteAutoPay Business Service |
| C1-ViewAutoPayService |
Used to view the auto pay instructions of an account. While sending the auto pay view request, you need to specify either of the following:
You can specify various criteria (such as, start date and auto pay source) along with the account details to filter the list of auto pay instructions. For more information, see C1-ViewAutoPay Business Service |
The system enables you to track the auto pay addition/modification, auto pay deletion, and auto pay view responses sent to the external system using the Inbound Web Service History feature.
We have not shipped any inbound web service with the product. You can create one inbound web service which supports all three operations - auto pay addition/modification, auto pay deletion, and auto pay view. Alternatively, you can create three inbound web services - one for auto pay addition/modification, another for auto pay deletion, and third for auto pay view.
You can create a SOAP or REST based inbound web service. If you want to send the request in the XML and/or JSON format, you need to ensure that you create a REST based inbound web service. However, if you want to send the request in the XML format, you can create a SOAP or REST based inbound web service.
Parent Topic: Maintaining The V