CancelSubmission

Cancels a submission by Submission Id.

POST Utility/CancelSubmission

Request Body

Field	Type	Description
RecordIds	object[]	Contains the list of RecordIds for which you are requesting the pdf URLs
SubmissionId	Guid	Unique identifier of a submission.

Request JSON

{
    "SubmissionId": "4cae8529-278c-441f-84ae-f07b5f0c0f1b",
    "RecordIds": [
        {
            "RecordId": "2684e4ee-5645-4ed2-9ccc-62132376e9ef"
        }
    ]
}

Response Body

Field	Type	Description
StatusCode	number	Returns the HTTP status codes like 200,300 etc.
StatusName	string	Name of the status code.
StatusMessage	string	Detailed status message.
SubmissionId	Guid	Unique identifier of a submission.
Status	string	Form 940 records success and error status
Errors	object[]	Shows detailed error information.
Code	string	Returns the validation error code.
Name	string	Name of the validation error.
Message	string	Description of the validation error.
Type	string	Type of validation error.

Response JSON

Success Response - This is a sample response for successful API requests.

{
   "StatusCode": 200,
   "StatusName": "Ok",
   "StatusMessage": "Successful API call",
   "SubmissionId": "4d7a31d9-6387-4c67-aa54-769465e6e551",
   "Status": "CANCELLED",
   "Errors": null
}