CSV File Format for Hold Upload Request
Before uploading a hold request file, you need to ensure that the CSV file contains the following columns:
| Column Name | Description | Mandatory (Yes or No) |
|---|---|---|
| Hold Request Type | Used to specify the hold request type. Note: You must specify
a valid hold request type which is in the Active status.
|
Yes |
| Start Date | Used to specify the date from when the hold request is effective. Note: The hold request start date cannot be later than the hold request
end date.
|
Yes |
| End Date | Used to specify the date till when the hold request is effective. Note: The hold request end date cannot be earlier than the hold request
start date.
|
Yes |
| Hold Reason | Used to indicate the reason why you want to hold the entity. Note: The hold reason must exists in the HOLD_REASON_FLG lookup field and its status must be Active.
|
Yes |
| Hold Entity | Used to indicate the type of the entity for which you want
to create the hold request. The valid values are:
|
Yes |
| Account Identifier Type | Used to specify the account identifier type. | Yes (Conditional) Note: This data is required when the hold
entity is ACCT and the entity ID is not specified.
|
| Account Identifier | Used to specify the identifier of the account for which you want to create the hold request. | Yes (Conditional) Note: This data is required when the hold
entity is ACCT and the entity ID is not specified.
|
| Person Identifier Type | Used to specify the person identifier type. | Yes (Conditional) Note: This data is required when the hold
entity is PERS and the entity ID is not specified.
|
| Person Identifier | Used to specify the identifier of the person for which you want to create the hold request. | Yes (Conditional) Note: This data is required when the hold
entity is PERS and the entity ID is not specified.
|
| Hold Entity ID | Used to specify the entity ID. Note:
If the hold entity is ACCT, you must specify the account ID in this field. If the hold entity is PERS, you must specify the person ID in this field. And, if the hold entity is BILL, you must specify the bill ID in this field. If you do not specify the account ID, the system derives the account ID using the account identifier type and account identifier combination. Similarly, if you do not specify the person ID, the system derives the person ID using the person identifier type and person identifier combination. |
Yes (Conditional) Note: This data is required when the hold
entity is BILL.
|
| Comments | Used to specify additional information about the hold request. | No |
| Hold Entity Start Date | Used to specify the date from when you want to hold the entity. Note:
The hold entity start date must be between the hold request start and end dates and between at least one process's start and end dates. The hold entity start date cannot be later than the hold entity end date. |
Yes |
| Hold Entity End Date | Used to specify the date till when you want to hold the entity. Note:
The hold entity end date must be between hold request start and end dates and between the process's start and end dates. The hold entity end date cannot be earlier than the hold entity start date. |
No |
| Hold Funding | Used to indicate whether you want to hold the funding process
for the entity. The valid values are:
Note: You can hold the funding process when the hold entity is PERS or BILL.
|
No |
| Hold Funding Start Date | Used to specify the date from when you want to hold the funding
process. Note:
The hold funding start date must be between the hold request start and end dates. The hold funding start date cannot be later than the hold funding end date. |
Yes (Conditional) Note: This data is required when the funding
process must be kept on hold.
|
| Hold Funding End Date | Used to specify the date till when you want to hold the funding
process. Note:
The hold funding end date must be between the hold request start and end dates. The hold funding end date cannot be earlier than the hold funding start date. |
No |
| Hold Overdue | Used to indicate whether you want to hold the overdue process
for the entity. The valid values are:
|
No |
| Hold Overdue Start Date | Used to specify the date from when you want to hold the overdue
process. Note:
The hold overdue start date must be between the hold request start and end dates. The hold overdue start date cannot be later than the hold overdue end date. |
Yes (Conditional) Note: This data is required when the overdue
process must be kept on hold.
|
| Hold Overdue End Date | Used to specify the date till when you want to hold the overdue
process. Note:
The hold overdue end date must be between the hold request start and end dates. The hold overdue end date cannot be earlier than the hold overdue start date. |
No |
| Hold Bill Generation | Used to indicate whether you want to hold the bill generation
process for the entity. The valid values are:
|
No |
| Hold Bill Generation Start Date | Used to specify the date from when you want to hold the bill
generation process. Note:
The hold bill generation start date must be between the hold request start and end dates. The hold bill generation start date cannot be later than the hold bill generation end date. |
Yes (Conditional) Note: This data is required when the bill
generation process must be kept on hold.
|
| Hold Bill Generation End Date | Used to specify the date till when you want to hold the bill
generation process. Note:
The hold bill generation end date must be between the hold request start and end dates. The hold bill generation end date cannot be earlier than the hold bill generation start date. |
No |
| Hold Auto Pay | Used to indicate whether you want to hold the automatic payment
process for the entity. The valid values are:
|
No |
| Hold Autopay Start Date | Used to specify the date from when you want to hold the automatic
payment process. Note:
The hold autopay start date must be between the hold request start and end dates. The hold autopay start date cannot be later than the hold autopay end date. |
Yes (Conditional) Note: This data is required when the automatic
payment process must be kept on hold.
|
| Hold Autopay End Date | Used to specify the date till when you want to hold the automatic
payment process. Note:
The hold autopay end date must be between the hold request start and end dates. The hold autopay end date cannot be earlier than the hold autopay start date. |
No |
| Effective Date1, Effective Date2, ....., Effective Date5 | Used to specify the date from when the characteristic is effective for the hold request. | Yes (Conditional) Note: This data is required when the characteristic
type or characteristic value is specified.
|
| Char Type1, Char Type2, ....., Char Type5 | Used to indicate the characteristic that must be defined
for the hold request. Note: You must specify a characteristic type
where the characteristic entity is set to Hold Request.
|
Yes (Conditional) Note: This data is required when the effective
date or characteristic value is specified.
|
| Char Val1, Char Val2, ....., Char Val5 | Used to specify the value for the characteristic type. | Yes (Conditional) Note: This data is required when the effective
date or characteristic type is specified.
|