Sample Hold Request Update Request and Response in the JSON Format

Using the below example, you can update all the fields in an active hold request where the hold request ID is 10000252262623

Sample Hold Request View Request in the JSON Format

{
    "UpdateHoldRequest":
    {
        "sourceSystem": "SMALL_NSC_PRIME",
        "externalTransactionId": "ETI22",
        "externalSourceId": "ESI99",
        "holdRequestId": "10000252262623",
        "holdComments": "Update the fields based on the request ID",
        "holdEndDate": "2022-01-31",
        "entityId": "0122334455",
        "entityEndDate": "2022-01-25",
        "holdProcessData":
        {
            "holdProcess": "BILL",
            "holdProcessEndDate": "2022-01-23"
        }
        "holdProcessData":
        {
            "holdProcess": "FNDG",
            "holdProcessEndDate": "2022-01-23"
        },
        "characteristics":
        {
            "action": "Update",
            "characteristicType": "INVOICE_TYPE",
            "characteristicValue": "CMR",
            "effectiveDate": "2022-01-01"
        },
        "characteristics":
        {
            "action": "Delete",
            "characteristicType": "INVOICE_HOLD_REASON",
            "characteristicValue": "CMDP",
            "effectiveDate": "2022-01-01"
        },
    }
 }

Sample Hold Request Update Response in the XML Format

The following information is received as response when the hold request update request is processed successfully.

{
    "UpdateHoldRequest":
    {
        "requestProcessStatus": "Success"
        "sourceSystem": "SMALL_NSC_PRIME",
        "externalTransactionId": "ETI22",
        "externalSourceId": "ESI99",
        "holdRequestId": "10000252262623",
        "holdComments": "Update the fields based on the request ID",
        "holdEndDate": "2022-01-31",
        "entityId": "0122334455",
        "entityEndDate": "2022-01-25",
        "holdProcessData":
        {
            "holdProcess": "BILL",
            "holdProcessEndDate": "2022-01-23"
        }
        "holdProcessData":
        {
            "holdProcess": "FNDG",
            "holdProcessEndDate": "2022-01-23"
        },
        "characteristics":
        {
            "action": "Update",
            "characteristicType": "INVOICE_TYPE",
            "characteristicValue": "CMR",
            "effectiveDate": "2022-01-01"
        },
    }
}

The following information is received from the hold request when the hold request is not longer present in the Active status.

{
    "UpdateHoldRequest":
    {
        "requestProcessStatus": "Failure"
        "sourceSystem": "SMALL_NSC_PRIME",
        "externalTransactionId": "ETI22",
        "externalSourceId": "ESI99",
        "holdRequestId": "10101252262623",
        "holdComments": "Update the fields based on the request ID",
        "holdEndDate": "2022-01-31",
        "entityId": "1133224455",
        "entityEndDate": "2022-01-25",
        "holdProcessData":
        {
            "holdProcess": "ATPY",
            "holdProcessEndDate": "2022-01-25"
        }
        "characteristics":
        {
            "action": "Update",
            "characteristicType": "STATE_OF_ISSUE",
            "characteristicValue": "TX",
            "effectiveDate": "2022-01-01"
        },
        "errormsg": "The hold request is not in the active status."
    }
}

Note: We have given the above request and response samples to illustrate how the attribute value pairs should be structured while sending a hold update request from the external system. However, you should not seamlessly use this request sample in your environment because the required pre-requisite data may not be available in your environment. In such case, the system will give erroneous results.

Related Topics

For more information on...	See...
Hold Request Update Request and Response - Attribute/Value Pairs in JSON Format	Hold Request Update Request and Response - Tags in JSON Format