Validate

Validate

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

GET Form940/Validate 

Run in Postman

Request Params

Field	Type	Description
SubmissionId	string	Unique identifier of a submission
RecordIds	string	List of record Ids to be transmitted.

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.
Form940Records	object	Pulls the Form 940 records with Success and Error statuses.
SuccessRecords	object[]	It will show the detailed information about the success status of Form 940 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 940 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.
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.
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

"Form940/Validate?SubmissionId=adfaa49c-58c7-4e66-a2df-1258dad0a3e1&RecordId=9657e565-c91c-455e-ac2b-d9ef18d19db6"

Response JSON

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

{
    "StatusCode": 200,
    "StatusName": "Ok",
    "StatusMessage": "Successful API call",
    "SubmissionId": "adfaa49c-58c7-4e66-a2df-1258dad0a3e1",
    "Form940Records": {
        "SuccessRecords": [
            {
                "SequenceId": null,
                "RecordId": "9657e565-c91c-455e-ac2b-d9ef18d19db6",
                "RecordStatus": "Created",
                "CreatedTs": "2025-03-20 05:26:20 -04:00",
                "UpdatedTs": "2025-03-20 05:27:56 -04:00",
                "Errors": null
            }
        ],
        "ErrorRecords": null
    },
    "Errors": null
}