Defining a Payment Request Type

Prerequisites

To define a payment request type, you should have:

  • Payment request type business objects defined in the application.

  • Approval profiles defined in the application.

  • The C1-PAYRQ To Do type assigned to a To Do role whose users must receive the To Do generated while submitting a payment request for an approval.

  • Defer algorithm defined using the C1-PAY-COUNT algorithm type

Procedure

To define a payment request type:

  1. Click the Admin link in the Application toolbar.
    A list appears.
  2. From the Admin menu, select P and then click Payment Request Type.
    A sub-menu appears.
  3. Click the Add option from the Payment Request Type sub-menu.

    The Select Business Object screen appears. It contains the following field:

    Field Name Field Description Mandatory (Yes or No)
    Payment Request Type Business Object Used to indicate the business object that you want to use to create the payment request type. Yes
    Tip: Alternatively, you can access the Select Business Object screen by clicking the Add button in the Page Title area of the Payment Request Type screen.
    Note: The Select Business Object screen appears when there are multiple payment request type business objects defined in the application. If there is only one payment request type business object defined in the application, the Payment Request Type screen appears.
  4. Select the required payment request type business object from the respective field.
  5. Click OK.

    The Payment Request Type screen appears. It contains the following sections:

    • Main - Used to specify basic details about the payment request type.

    • Characteristics - Used to define the characteristics for the payment request type.

    The Main section contains the following fields:

    Field Name Field Description Mandatory (Yes or No)
    Payment Request Type Used to specify the payment request type. Yes
    Business Object Indicates the business object using which you are defining the payment request type. Not applicable
    Payment Request Business Object Used to indicate the business object using which you want to create the respective payment request. The valid values are:

    • Payment Request (C1-PaymentRequest) - Enables you to create a payment request using the respective payment request type.

    • Payment Transfer Request (C1-PaymentTransferRequest) - Enables you to create a payment transfer request using the respective payment request type.

    		 Yes
    Description Used to specify the description for the payment request type. Yes
    Detailed Description Used to specify additional information about the payment request type. No
    Status Used to indicate the status of the payment request type. The valid values are:

    • Active

    • Inactive

    Note: You cannot change the status of a payment request type to Inactive when the corresponding payment request is in the Draft or Approval In Progress status.
    		 Yes
    Defer Algorithm Used to attach an algorithm that will be triggered when you distribute tender or payment amount by clicking the Distribute button.
    Note:

    The Search (The Search Icon) icon appears corresponding to the Defer Algorithm field. On clicking the Search icon, the Algorithm Search window appears.

    On specifying the algorithm, the description of the algorithm appears corresponding to the Defer Algorithm field.

    You need to attach an algorithm created using the C1-PAY-COUNT algorithm type to this field. This algorithm checks whether the number of payment distribution records in the payment request exceeds the payment count. If the number of payment distribution records in the payment request does not exceed the payment count, the system distributes the tender or payment amount, and creates the payment event and the respective payments in real time (i.e. immediately). However, if the number of payment distribution records in the payment request exceeds the payment count, the system distributes the tender or payment amount in the deferred mode. This algorithm calculates the number of records to be processed for the account in the following manner:

    Number of payment distribution records =
    (Number of bill segments present in each bill fetched using the bill weighted, bill regular, and bill match type algorithm) +
    (Number of bill segments fetched using the bill segment match type algorithm) +
    (Number of contracts fetched using the suspense contract match type algorithm) +
    (Number of settlements fetched using the settlement match type algorithm)

    Deferred mode means in the background when the Payment Request Periodic Monitor (C1-PAYRQ) batch is invoked. You can configure the Payment Request Periodic Monitor (C1-PAYRQ) batch such that it is executed at regular intervals. When the Payment Request Periodic Monitor (C1-PAYRQ) batch is invoked, the system checks whether there are any payment requests in the Deferred Distribution status. If there is a payment request in the Deferred Distribution status, the system distributes tender or payment amount and accordingly creates payment event and payments.

    		 Yes
    Approval Required Used to indicate whether approval is required to freeze the payments of the payment requests which are created using the respective payment request type. No
    Approval To Do Type Used to indicate that the To Do entry of the specified To Do type must be created when the payment request is submitted for approval.
    Note:

    The Search (The Search Icon) icon appears corresponding to this field. On clicking the Search icon, the To Do Type Search window appears.

    On selecting the To Do Type, the description of the To Do type appears corresponding to the Approval To Do Type field.

    This field appears when the Approval Required option is selected.

    The C1-PAYRQ is shipped with the product. You can use the C1-PAYRQ To Do type or a custom To Do type, if required.

    		 Yes (Conditional)
    Note: This field is required when the Approval Required option is selected.
    Approval To Do Role Used to indicate that users with the specified To Do role can only approve the payment request submitted for approval.
    Note: This field appears when the Approval Required option is selected.
    		 Yes (Conditional)
    Note: This field is required when the Approval Required option is selected.
    Transfer Used to indicate whether the payment request type is used to create either a payment request or payment transfer request. No
    Defer Payment Processing Count Used to indicate whether a payment request must be processed in the deferred mode (i.e. in the background) when the number of payments in the payment request exceed the defer processing count.
    Note:

    Deferred mode means in the background when the Payment Request Periodic Monitor (C1-PAYRQ) batch is invoked. You can configure the Payment Request Periodic Monitor (C1-PAYRQ) batch such that it is executed at regular intervals. For more information about the Payment Request Periodic Monitor (C1-PAYRQ) batch, refer to Oracle Revenue Management and Billing Batch Guide.

    If the number of bills in a payment request does not exceed the defer processing count, the system processes the payment request in real time (i.e. immediately).

    You cannot specify a negative value in the Defer Payment Processing Count field. If you do not specify the defer payment processing count, by default, it is set to zero (0).

    This field appears when the Transfer option is selected.

    		 No
  6. Enter the required details in the Main section.
  7. Define characteristics for the payment request type, if required.
  8. Click Save.
    The payment request type is defined.

Related Topics

For more information on... See...
Payment Request Type screen Payment Request Type
Payment Request Type List zone Payment Request Type List
How to define a characteristic for a payment request type Defining a Characteristic for a Payment Request Type