Validate

Validate method will execute business and data validation checks for the Form 941 returns already created in API. To validate the returns, use the Submission ID and Record IDs of the particular return to validate.

GET Form941/Validate 

Request Params

Field	Type	Description
SubmissionId	Guid	Unique identifier of a submission
RecordIds	Guid[]	Unique identifier of a record

Request Params

Provide the SubmissionId and RecordId to validate the 941 Form return.

"Form941/Validate?SubmissionId=bbde2477-50d0-486b-a405-e8ca4733c00d&RecordIds=f93602df-ceaf-48a4-a3cf-431bb6b6ddba"

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.
Form941Records	object	Pulls the Form 941 records with Success and Error statuses.
SuccessRecords	object[]	It will show the detailed information about the success status of Form 941 Records.
SequenceId	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.
ErrorRecords	object[]	It will show the detailed information about the error status of Form 941 Records.
RecordId	Guid	Unique identifier of a record.
SequenceId	string	A unique number given by an inbound application to identify failed records.
Errors	object[]	Shows detailed error information.
Id	string	Returns the validation error id.
Name	string	Name of the validation error.
Message	string	Description of the validation error.
Errors	object[]	Shows detailed error information.
Id	string	Returns the validation error id.
Name	string	Name of the validation error.
Message	string	Description of the validation error.

Response JSON

For the given parameters, 941 Form will be validated.

{
   "StatusCode": 200,
   "StatusName": "Ok",
   "StatusMessage": "Successful API call",
   "SubmissionId": "bbde2477-50d0-486b-a405-e8ca4733c00d",
   "Form941Records": {
       "SuccessRecords": [
           {
               "SequenceId": "001",
               "RecordId": "f93602df-ceaf-48a4-a3cf-431bb6b6ddba",
               "RecordStatus": "Created",
               "CreatedTs": "2022-03-02 06:00:06 -05:00",
               "UpdatedTs": "2022-03-02 06:19:00 -05:00"
           }
       ],
       "ErrorRecords": null
   },
   "Errors": null
}