Adjustment Cancellation Request and Response - Attribute/Value Pairs in JSON Format

Note: We recommend you to refer the Adjustment Cancellation Request in the JSON Format and Adjustment Cancellation Response in the JSON Format topics in parallel while understanding the below mentioned attributes. This will help you to understand how the attribute/value pairs are structured in the JSON format.

Before calling the C1-CancelAdjustment business service through an inbound web service, you need to ensure that the adjustment cancellation request contains the following attributes:

Attribute Name	Attribute Description	Mandatory (Yes or No)
C1-CancelAdjustment	Used to indicate that you want to invoke the C1-CancelAdjustment business service.	Yes
cancelAdjRequest	Used to specify the details of the adjustment.	Yes
adjustmentId	Used to indicate the adjustment that you want to cancel. Note: You must specify an adjustment which already exists in the system.	Yes
reason	Used to indicate the reason why you want to cancel the adjustment. Note: You must specify an adjustment cancel reason which is already defined in the system.	Yes
sourceSystem	Used to indicate the external system from which the adjustment cancellation 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 adjustment cancellation 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 adjustment cancellation 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

The following table lists and describes the attributes which appear in the adjustment cancellation response in the JSON format:

Attribute Name	Attribute Description
cancelAdjResponse	Indicates whether the adjustment cancellation request is successfully processed or not.
messageText	Indicates the error that occurred while canceling the adjustment. Note: This attribute appears when the value of the statusCd attribute is set to Fail.
cancelReasonDesc	Indicates the reason why the adjustment is canceled.
adjustmentStatus	Indicates the status of the adjustment. The valid value is: Canceled
statusCd	Indicates whether the adjustment cancellation request is successfully processed or not. The valid values are: Success Fail

Related Topics

For more information on...	See...
Sample Adjustment Cancellation Request and Response in the JSON Format	Sample Adjustment Cancellation Request and Response in the JSON Format