Mass Refund Request Creation CSV Format

The following table lists and describes the columns that should be available in the CSV file while creating multiple refund requests at once through an upload request:

Sr. No. Column Name Description Mandatory (Yes or No)
1 Refund Request Type Used to specify the refund request type using which you want to create the refund request.
Note: You must specify a refund request type which is already defined in the system. It should be in the Active status.
 Yes
2 Account Identifier Type Used to specify the account identifier type.
Note: You must specify an account identifier type which is already defined in the system.
 Yes (Conditional)
Note: This data is required when the account ID is not specified in the record.
3 Account Identifier Used to specify the account identifier.
Note: The system derives the account using the given account identifier type and account identifier combination when the account ID is either not specified or is invalid in the record.
 Yes (Conditional)
Note: This data is required when the account ID is not specified in the record.
4 Account ID Used to indicate the account for which you want to create the refund request. Yes (Conditional)
Note: This data is required when the account identifier type and account identifier are not specified in the record.
5 Entity Type Used to specify the entity type. The valid values are:

  • Adjustment - Used when you want to refund a credit adjustment of an account through a refund request.

  • Bill - Used when you want to refund a credit bill of an account through a refund request.

  • Bill Segment - Used when you want to refund a credit bill segment of an account through a refund request.

  • Payment Event - Used when you want to refund all the payments of a payment event created for a payor account through a refund request.

  • Payment - Used when you want to refund a specific payment of an account through a refund request.

Note: You must specify a value which is already defined in the REF_​WO_​ENTITY_​FLG lookup field. It should be in the Active status.
 Yes
6 Entity ID Used to specify the entity ID.
Note:

Here, you can specify the adjustment ID, bill ID, bill segment ID, payment event ID, or payment ID depending on the specified entity type.

The specified payment should be in the Frozen status and matched against the suspense or excess credit contract.

The specified bill should be in the Complete status.

The specified bill segment should be in the Frozen status.

The specified adjustment should be in the Freezable or Frozen status.

 Yes
7 Adjustment Type Used to specify the adjustment type using which you want to create the refund adjustment for the entity.
Note:

You must specify an adjustment type which is already defined in the system. Its A/P Request Type Code flag should be set to Refund.

If you do not specify the adjustment type, the system considers the refund adjustment type specified in the respective refund request type.

 No
8 Refund Amount Used to specify the amount that you want to refund.
Note:

You must specify a number greater than zero but less than or equal to the eligible refund amount.

You must specify a number with decimal positions less than or equal to the decimal positions defined for the respective currency.

 Yes
9 Comments Used to specify additional information about the refund request. No
10 Effective Date1, Effective Date2, ....., Effective Date5 Used to specify the date from when the characteristic is effective for the refund request. Yes (Conditional)
Note: This data is required when the characteristic type is specified in the record.
11 Char Type1, Char Type2, ....., Char Type5 Used to specify the characteristic type.
Note:

You must specify a characteristic type where the characteristic entity is set to Refund/Write Off Request.

You can specify maximum 5 characteristics in the record.

 No
12 Char Val1, Char Val2, ....., Char Val5 Used to specify the value for the characteristic type. Yes (Conditional)
Note: This data is required when the characteristic type is specified in the record.
Note:

The CSV file should contain the columns in the above mentioned sequence. You can add five sets of characteristics — each set containing Effective Date, Char Type, and Char Val followed by the subsequent set (i.e., Effective Date1, Char Type1, Char Val1, Effective Date2, Char Type2, Char Val2, Effective Date3, Char Type3, Char Val3, Effective Date4, Char Type4, Char Val4, Effective Date5, Char Type5, Char Val5).

Before uploading the file, ensure that the column headers specified in the CSV file are mapped to the schema of the respective upload request business object through data mapping in the upload request type. Otherwise, erroneous results might occur. For more information, see Mapping Data and Configuring Filters for an Upload Request Type.