3. Cancel Request and Response Specification

3.1 Cancel Request

The Cancel Request method is used to cancel a previous tax calculation process web request. Only In-Progress and Finalized web requests for the current and prior calendar months can be cancelled.

Caution

After a successful Cancel Request method is performed, all data regarding that transaction will no longer be included on any SureTax user generated reports. For returns/credits, Cancel Request is not a recommended method. Instead, you should create a new calculation request with negative line values to create an audit trail.

For REST Integrations:
Method: CancelPostRequest
URL: <environment url>/Services/V07/SureTax.asmx/CancelPostRequest

For SOAP Integrations:
Method: CancelSoapRequest
URL: <environment url>/Services/V07/SureTax.asmx

3.2 Cancel Request Layout

Field names formatted in BOLD are required fields that must be passed to SureTax API. All Field Names are case-sensitive. Field values are required unless otherwise noted in their description below.

Request Record

FIELD	FIELD NAME	DESCRIPTION
Client Number	ClientNumber	Client ID Number provided by CCH SureTax.
Client Tracking Field	ClientTracking	Optional. Field for client transaction tracking.
Transaction ID	TransId	Transaction ID of web request to be cancelled.
Validation Key	ValidationKey	Validation Key provided by CCH SureTax.

requestCancel={
	"ClientNumber": "<CLIENTNUMBER>",
	"ValidationKey": "<VALIDATIONKEY>",
	"ClientTracking": "<CLIENTTRACKING>",
	"TransId": 841901824,
}

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:tem="http://tempuri.org/">
   <soapenv:Header/>
   <soapenv:Body>
      <tem:CancelSoapRequest>
         <tem:requestCancel>
            <tem:ClientNumber><CLIENTNUMBER></tem:ClientNumber>
            <tem:ValidationKey><VALIDATIONKEY></tem:ValidationKey>
            <tem:ClientTracking><CLIENTTRACKING></tem:ClientTracking>
            <tem:TransId>841901824</tem:TransId>
         </tem:requestCancel>
      </tem:CancelSoapRequest>
   </soapenv:Body>
</soapenv:Envelope>

Cancel Response Layout

Cancel Response Message

FIELD NAME	DESCRIPTION
Successful	Response will be either "Y" or "N": Y = Success / Success with Item error N = Failure
ResponseCode	9999 - Request was successful. 1101-1600 - Range of values for a failed request (no processing occurred). 1150 - Failure - Validation Key Required. 1151 - Failure - Invalid Validation Key. 1510 - Failure - Transaction is more than 60 days old. 9010 -Failure - Transaction is already cancelled.
HeaderMessage	For ResponseCode 9999 - "Success" For ResponseCode 9001 - "Success with Item errors". See the ItemMessages field for a list of items / errors. For ResponseCode 1100-1600 - Unsuccessful / declined web request. See Response Code and Messages for full list.
ClientTracking	Client transaction tracking provided in web request.
TransId	Transaction ID (integer) - Unique identifier for your transaction provided by CCH SureTax

Examples

REST with JSON
SOAP

{
	"HeaderMessage": "Success",
	"ResponseCode": "9999",
	"Successful": "Y",
	"TransId": 841901824
}

<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
   <soap:Body>
      <CancelSoapRequestResponse xmlns="http://tempuri.org/">
         <CancelSoapRequestResult>
            <Successful>Y</Successful>
            <ResponseCode>9999</ResponseCode>
            <HeaderMessage>Success</HeaderMessage>
            <TransId>841901824</TransId>
         </CancelSoapRequestResult>
      </CancelSoapRequestResponse>
   </soap:Body>
</soap:Envelope>

3.3 Cancel Request with Invoice Layout

Cancel request with Invoice will cancel a transaction where the transaction id and the invoice number match the values sent in the request. Field names formatted in BOLD are required fields that must be passed to SureTax API. All Field Names are case-sensitive. Field values are required unless otherwise noted in their description below.

Request Record

FIELD	FIELD NAME	DESCRIPTION
Client Number	ClientNumber	Client ID Number provided by CCH SureTax.
Client Tracking Field	ClientTracking	Optional. Field for client transaction tracking.
Transaction ID	TransId	Transaction ID of web request to be cancelled.
Validation Key	ValidationKey	Validation Key provided by CCH SureTax.
Invoice Number	InvoiceNumber	Invoice Number that was sent with the transaction that needs to be canceled.

Examples

REST with JSON
SOAP

requestCancel={
	"ClientNumber": "<CLIENTNUMBER>",
	"ValidationKey": "<VALIDATIONKEY>",
	"ClientTracking": "<CLIENTTRACKING>",
	"TransId": 841901824,
	"InvoiceNumber": "TESTINV1000"
}

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:tem="http://tempuri.org/">
   <soapenv:Header/>
   <soapenv:Body>
      <tem:CancelSoapRequestWithInvoice>
         <tem:requestCancel>
            <tem:ClientNumber><CLIENTNUMBER></tem:ClientNumber>
            <tem:ValidationKey><VALIDATIONKEY></tem:ValidationKey>
            <tem:ClientTracking><CLIENTTRACKING></tem:ClientTracking>
            <tem:TransId>841901824</tem:TransId>
            <tem:InvoiceNumber>TESTINV1000</tem:InvoiceNumber>
         </tem:requestCancel>
      </tem:CancelSoapRequestWithInvoice>
   </soapenv:Body>
</soapenv:Envelope>

Cancel Response with Invoice Layout

Cancel Response Message

FIELD NAME	DESCRIPTION
Successful	Response will be either "Y" or "N": Y = Success / Success with Item error N = Failure
ResponseCode	9999 - Request was successful. 1101-1600 - Range of values for a failed request (no processing occurred). 1150 - Failure - Validation Key Required. 1151 - Failure - Invalid Validation Key. 1510 - Failure - Transaction is more than 60 days old. 9010 -Failure - Transaction is already cancelled.
HeaderMessage	For ResponseCode 9999 - "Success" For ResponseCode 9001 - "Success with Item errors". See the ItemMessages field for a list of items / errors. For ResponseCode 1100-1600 - Unsuccessful / declined web request. See Response Code and Messages for full list.
ClientTracking	Client transaction tracking provided in web request.
TransId	Transaction ID (integer) - Unique identifier for your transaction provided by CCH SureTax

Examples

REST with JSON
SOAP

{
	"HeaderMessage": "Success",
	"ResponseCode": "9999",
	"Successful": "Y",
	"TransId": 841901824
}

<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
   <soap:Body>
      <CancelSoapRequestWithInvoiceResponse xmlns="http://tempuri.org/">
         <CancelSoapRequestWithInvoiceResult>
            <Successful>Y</Successful>
            <ResponseCode>9999</ResponseCode>
            <HeaderMessage>Success</HeaderMessage>
            <TransId>841901824</TransId>
         </CancelSoapRequestWithInvoiceResult>
      </CancelSoapRequestWithInvoiceResponse>
   </soap:Body>
</soap:Envelope>

3.4 Cancel Request with STAN Layout

Cancel request with STAN will cancel a transaction where the transaction id and the STAN match the values sent in the request.

Request Record

FIELD	FIELD NAME	DESCRIPTION
Client Number	ClientNumber	Client ID Number provided by CCH SureTax.
Client Tracking Field	ClientTracking	Optional. Field for client transaction tracking.
Transaction ID	TransId	Transaction ID of web request to be cancelled.
Validation Key	ValidationKey	Validation Key provided by CCH SureTax.
STAN	STAN	STAN that was sent with the transaction that needs to be canceled.

Examples

REST with JSON
SOAP

requestCancel={
	"ClientNumber": "<CLIENTNUMBER>",
	"ValidationKey": "<VALIDATIONKEY>",
	"ClientTracking": "<CLIENTTRACKING>",
	"TransId": 841901824,
	"STAN": "TESTSTAN1000"
}

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:tem="http://tempuri.org/">
   <soapenv:Header/>
   <soapenv:Body>
      <tem:CancelSoapRequestWithSTAN>
         <tem:requestCancel>
            <tem:ClientNumber><CLIENTNUMBER></tem:ClientNumber>
            <tem:ValidationKey><VALIDATIONKEY></tem:ValidationKey>
            <tem:ClientTracking><CLIENTTRACKING></tem:ClientTracking>
            <tem:TransId>841901824</tem:TransId>
            <tem:STAN>TESTSTAN1000</tem:STAN>
         </tem:requestCancel>
      </tem:CancelSoapRequestWithSTAN>
   </soapenv:Body>
</soapenv:Envelope>

Cancel Response with STAN Layout

Cancel Response Message

FIELD NAME	DESCRIPTION
Successful	Response will be either "Y" or "N": Y = Success / Success with Item error N = Failure
ResponseCode	9999 - Request was successful. 1101-1600 - Range of values for a failed request (no processing occurred). 1150 - Failure - Validation Key Required. 1151 - Failure - Invalid Validation Key. 1510 - Failure - Transaction is more than 60 days old. 9010 -Failure - Transaction is already cancelled.
HeaderMessage	For ResponseCode 9999 - "Success" For ResponseCode 9001 - "Success with Item errors". See the ItemMessages field for a list of items / errors. For ResponseCode 1100-1600 - Unsuccessful / declined web request. See Response Code and Messages for full list.
ClientTracking	Client transaction tracking provided in web request.
TransId	Transaction ID (integer) - Unique identifier for your transaction provided by CCH SureTax

Examples

REST with JSON
SOAP

{
	"HeaderMessage": "Success",
	"ResponseCode": "9999",
	"Successful": "Y",
	"TransId": 841901824
}

<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
   <soap:Body>
      <CancelSoapRequestWithSTANResponse xmlns="http://tempuri.org/">
         <CancelSoapRequestWithSTANResult>
            <Successful>Y</Successful>
            <ResponseCode>9999</ResponseCode>
            <HeaderMessage>Success</HeaderMessage>
            <TransId>841901824</TransId>
         </CancelSoapRequestWithSTANResult>
      </CancelSoapRequestWithSTANResponse>
   </soap:Body>
</soap:Envelope>

3.5 Cancel Request with MasterTransId Layout

Cancel request with MasterTransId will cancel all transactions where the MasterTransId match the value sent in the request.

Request Record

FIELD	FIELD NAME	DESCRIPTION
Client Number	ClientNumber	Client ID Number provided by CCH SureTax.
Client Tracking Field	ClientTracking	Optional. Field for client transaction tracking.
Master Transaction ID	MasterTransId	Master transaction id of web requests to be cancelled.
Validation Key	ValidationKey	Validation Key provided by CCH SureTax.

Examples

REST with JSON
SOAP

requestCancel={
	"ClientNumber": "<CLIENTNUMBER>",
	"ValidationKey": "<VALIDATIONKEY>",
	"ClientTracking": "<CLIENTTRACKING>",
	"MasterTransId": 841901824
}

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:tem="http://tempuri.org/">
   <soapenv:Header/>
   <soapenv:Body>
      <tem:CancelRequestWithMasterTransId>
         <tem:requestCancel>
            <tem:ClientNumber><CLIENTNUMBER></tem:ClientNumber>
            <tem:ValidationKey><VALIDATIONKEY></tem:ValidationKey>
            <tem:ClientTracking><CLIENTTRACKING></tem:ClientTracking>
            <tem:MasterTransId>841901824</tem:MasterTransId>
         </tem:requestCancel>
      </tem:CancelRequestWithMasterTransId>
   </soapenv:Body>
</soapenv:Envelope>

Cancel Response with MasterTransId Layout

Cancel Response Message

FIELD NAME	DESCRIPTION
Successful	Response will be either "Y" or "N": Y = Success / Success with Item error N = Failure
ResponseCode	9999 - Request was successful. 1101-1600 - Range of values for a failed request (no processing occurred). 1150 - Failure - Validation Key Required. 1151 - Failure - Invalid Validation Key. 1510 - Failure - Transaction is more than 60 days old. 9010 -Failure - Transaction is already cancelled.
HeaderMessage	For ResponseCode 9999 - "Success" For ResponseCode 9001 - "Success with Item errors". See the ItemMessages field for a list of items / errors. For ResponseCode 1100-1600 - Unsuccessful / declined web request. See Response Code and Messages for full list.
ClientTracking	Client transaction tracking provided in web request.
TransId	Transaction ID (integer) - Unique identifier for your transaction provided by CCH SureTax

Examples

REST with JSON
SOAP

{
	"HeaderMessage": "Success",
	"ResponseCode": "9999",
	"Successful": "Y",
	"TransId": 841901824
}

<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
   <soap:Body>
      <CancelRequestWithMasterTransIdResponse xmlns="http://tempuri.org/">
         <CancelRequestWithMasterTransIdResult>
            <Successful>Y</Successful>
            <ResponseCode>9999</ResponseCode>
            <HeaderMessage>Success</HeaderMessage>
            <TransId>841901824</TransId>
         </CancelRequestWithMasterTransIdResult>
      </CancelRequestWithMasterTransIdResponse>
   </soap:Body>
</soap:Envelope>