Hold Request Creation Request and Response - Tags in XML Format

Note: We recommend you to refer theHold Request Creation Request in the XML Format and Hold Request Creation Response in the XML Format topics in parallel while understanding the below mentioned tags. This will help you to understand how the tags are nested in the XML format.

Before calling the C1-CreateHoldRequest business service through an inbound web service, you need to ensure that the hold request creation request contains the following tags:

Tag Name Tag Description Mandatory (Yes or No)
C1-CreateHoldRequest Used to indicate that you want to invoke the C1-CreateHoldRequest business service. Yes
holdRequest Used to specify the details of the hold request. Yes
sourceSystem Used to indicate the external system from which the hold creation request is sent.
Note:

You must specify an external system which is already defined in the system.

The external system is used when the Inbound Web Service History feature is enabled. The specified external system should match the external system which is associated with the outbound message type specified in the C1-IWSHIST algorithm. If the external system is not specified in the hold request creation request, the system, by default, stamps the external system associated with the outbound message type (specified in the C1-IWSHIST algorithm) corresponding to the record in the C1_​IWS_​HIST table. For more information, see Inbound Web Service History.

 No
externalTransactionId Used to indicate the transaction in the external system through which the hold request creation request is sent.
Note: The external transaction ID is used when the Inbound Web Service History feature is enabled.
 No
externalSourceId Used to specify the external source system ID.
Note: The external source system ID is used when the Inbound Web Service History feature is enabled.
 No
holdStartDate Used to specify the date from when the hold request is effective. Yes
holdEndDate Used to specify the date till when the hold request is effective.
Note: The hold request end date must be either derived or provided by the upstream system before creating a hold request in an Active status.
 Yes (Conditional)
Note: This data is required if the holdDays is not specified.
holdDays Used to specify the number of days an entity should be kept on hold in the hold request.
Note:

If the holdEndDate is not specified, the system calculates the holdEndDate by adding the holdDays to the holdStartDate.

The system considers the holdDays as calendar days which include all the 7 days in a week.

 Yes (Conditional)
Note: This data is required if holdEndDate is not specified.
holdRequestType Used to specify an active hold request type where the approval process is not configured for activation and release.
Note: If an active hold request type is used where the approval process is configured, the system throws an error with a failure response.
 No
holdEntity Used to indicate the type of the entity for which you want to create the hold request. The valid values are:

  • ACCT - Used when you want to specify the account.

  • BILL - Used when you want to specify the bill.

  • PERS - Used when you want to specify the person.

Note:
If... Then
You are creating the hold request for an ACCT entity You can add Auto Pay, Bill Generation, Funding, and Overdue process in the hold request.
You are creating the hold request for a BILL entity You can only add Funding process in the hold request.
You are creating the hold request for a PERS entity You can add Bill Generation and Funding process in the hold request.

You must specify a value which is already defined in the HOLD_​ENTITY_​LVL_​FLG lookup field. It must be in the Active status.

 Yes
holdReason Used to specify the reason for the hold request.
Note: You must specify a value which is already defined in the HOLD_​REASON_​FLG lookup field and is in the Active status.
 Yes
holdComments Used to specify additional information about the hold request. No
entityIdentifierType Used to specify the entity type.
Note: You cannot specify BILL as a type for the entity identifier.
 Yes (Conditional)
Note: This data is required while defining or editing a hold request.
entityIdentifierValue Used to specify the entity identifier (i.e. account or person).
Note: You cannot specify BILL as a value for the entity identifier.
 Yes (Conditional)
Note: This data is required while defining or editing a hold request.
entityId Used to specify a list of entities for which you want to create a hold request.
Note: You need to specify the entity ID when the hold entity is BILL.
 Yes (Conditional)
Note: This data is required while defining or editing a hold request.
holdEntityEndDate Used to specify the date till when the entity is effective for hold request. No
hierarchySwitch Used to associate the hold entity with the entity hierarchy relationship. No
holdProcessData Used to specify process information for the hold request. Yes
holdProcess Used to specify the process that you want to keep on hold in the hold request. The valid values are:

  • ATPY - Used when you want to specify the auto pay process.

  • BILL - Used when you want to specify the bill generation process.

  • FNDG - Used when you want to specify the funding process.

  • OVDU - Used when you want to specify the overdue process.

Note: You must specify a value which is already defined in the HOLD_​PROCESS_​FLG lookup field. It must be in the Active status.
 Yes
holdProcessEndDate Used to specify the date till when the entity is effective for hold request. No
characteristics Used to specify a characteristic for the hold request. Yes
characteristicType Used to indicate the characteristic type.
Note: You must specify a characteristic type where the characteristic entity is set to Hold Request and which is associated with the hold request type.
 Yes
characteristicValue Used to specify the value for the characteristic type. Yes
effectiveDate Used to specify the date from when the characteristic is effective. Yes

The following table lists and describes the tags which appear in the hold request creation response in the XML format:

Tag Name Tag Description
statusCd Indicates whether the hold request creation request is successfully processed or not. The valid values are:

  • Success

  • Failure
holdRequestId Displays the hold request ID.
holdStatus Indicates the current status of the hold request.
messageText Indicates the error that occurred while creating the hold request.
Note: This tag appears when the value in the statusCd tag is set to Failure.

Related Topics

For more information on... See...
Sample Hold Request Creation Request and Response in the XML Format Sample Hold Request Creation Request and Response in the XML Format