4. Finalize Request and Response Specification

4.1 Finalize Request

The Finalize Request method is used to update a previous In-Progress transaction (see ReturnFile Code value of "T"). Only finalized transactions will appear on SureTax reports. You can only finalize an In-Progress using the MasterTransID provided to you from a previous SureTax Calculation Request response.

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

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

4.2 Finalize 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.
Validation Key	ValidationKey	Validation Key provided by CCH SureTax. Required for client access to API function.
Client Tracking Field	ClientTracking	Optional. Field for client transaction tracking.
Master TranID	MasterTransID	The "master" SureTax TransID assigned to an in-progress transaction.

Examples

• REST with JSON
• SOAP

requestFinalize={
	"ClientNumber": "<CLIENTNUMBER>",
	"ValidationKey": "<VALIDATIONKEY>"
	"MasterTransID": "2117664044",
}

4.3 Finalize Request Layout

Finalize Request Message

FIELD NAME	DESCRIPTION
Successful	Response will be either "Y" or "N": Y = Success / Success with Item error N = Failure
ResponseCode	ResponseCode: 9999 - Request was successful. 1101-1600 - Range of values for a failed request (no processing occurred).
HeaderMessage	Response message: 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 Appendix D - Response Code and Messages for a list.
ClientTracking	Field for client transaction.
MasterTransID	The "master" SureTax TransID assigned to an in-progress transaction.

Examples

• REST with JSON
• SOAP

{
	"HeaderMessage": "Success",
	"ResponseCode": "9999",
	"Successful": "Y",
	"MasterTransId": 841901814
}