Validate

Validate

Runs business and data validation checks for the 940 SchR forms already created in API. You must use the Submission ID of the return to Validate.

GET Form940SchR/Validate 

Run in Postman

Request Params

Field	Type	Description
SubmissionId	string	Unique identifier of a submission.
RecordIds	string	List of Record IDs for Validation.

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
Form940SchRRecords	object	Pulls the Form 940SCHR records with Success and Error statuses
SuccessRecords	object[]	It will show the detailed information about the success status of Form 940 Records
Sequence	string	A unique number given by an inbound application to identify failed records.
RecordId	Guid	Unique identifier of a record.
RecordStatus	string	Returns the status of the records.
CreatedTs	string	Date and time of return created.
UpdatedTs	string	Date and time of return updated.
ClientSuccessRecords	object[]	Client Success Status.
CSeqId	string	This identifies the sequence on the record sent in the payload. When errors occur we will send the errors attached to particular sequence.
CRecordId	string	Client Record Identifier
RecordStatus	string	Return status details like Processing, Created, Accepted, Rejected.
CreatedTs	string	Return created date and time
UpdatedTs	string	Return updated date and time
ErrorRecords	object[]	It will show the detailed information about the error status of Form 940 Records
RecordId	Guid	Unique identifier of a record
Sequence	string	A unique number given by an inbound application to identify failed records.
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.
ClientErrorRecords	object[]	Client Error Status.
CSeqId	object[]	This identifies the sequence on the record sent in the payload. When errors occur we will send the errors attached to particular sequence.
CRecordId	object[]	Client Record Identifier
Errors	object[]	It will show the detailed information about the error.
Code	string	It will return the validation error code.
Name	string	It will return the name of the validation error.
Message	string	It will return the detailed message of the validation error.
Type	string	It will show the type of an error.
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.

Request Params

"Form940SCHR/Validate?SubmissionId=9723f666-c46e-43e6-8c56-8cba391acbf7&RecordIds=554fb9c3-b68b-4a52-9114-792cd4a70433"

Response JSON

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

{
 "StatusCode": 200,
 "StatusName": "Ok",
 "StatusMessage": "Successful API call",
 "SubmissionId": "9723f666-c46e-43e6-8c56-8cba391acbf7",
 "Form940SchRRecords": {
   "SuccessRecords": [
     {
       "Sequence": "",
       "RecordId": "554fb9c3-b68b-4a52-9114-792cd4a70433",
       "RecordStatus": "Created",
       "CreatedTs": "2019-08-07 02:59:41 -04:00",
       "UpdatedTs": "2019-08-07 03:24:00 -04:00",
       "ClientSuccessRecords": null
     }
   ],
   "ErrorRecords": null
 },
 "Errors": null
}