Skip to main content
Version: 1.7.3

Validate

GET Form944/Validate 

Request Params

FieldTypeDescription
SubmissionIdGuidUnique identifier of a submission

Request Params

"Form944/validate?SubmissionId=496570cd-e218-4f91-83e6-1549ea8ce525"

Response Body

FieldTypeDescription
StatusCodenumberReturns the HTTP status codes like 200,300 etc.
StatusNamestringName of the status code.
StatusMessagestringDetailed status message.
SubmissionIdGuidUnique identifier of a submission.
Form944RecordsobjectPulls the Form 941 records with Success and Error statuses.
    SuccessRecordsobject[]It will show the detailed information about the success status of Form 944 Records.
        SequenceIdstringA unique number given by an inbound application to identify failed records.
        RecordIdGuidUnique identifier of a record.
        RecordStatusstringReturns the status of the records.
        CreatedTsstringDate and time of return created.
        UpdatedTsstringDate and time of return updated.
    ErrorRecordsobject[]It will show the detailed information about the error status of Form 944 Records.
        RecordIdGuidUnique identifier of a record.
        SequenceIdstringA unique number given by an inbound application to identify failed records.
        Errorsobject[]Shows detailed error information.
            IdstringReturns the validation error id.
            NamestringName of the validation error.
            MessagestringDescription of the validation error.
Errorsobject[]Shows detailed error information.
    IdstringReturns the validation error id.
    NamestringName of the validation error.
    MessagestringDescription of the validation error.

Response JSON

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

{
"StatusCode": 200,
"StatusName": "Ok",
"StatusMessage": "Successful API call",
"SubmissionId": "496570cd-e218-4f91-83e6-1549ea8ce525",
"Form944Records": {
"SuccessRecords": [
{
"SequenceId": "001",
"RecordId": "7d9a60e8-e6d6-4c1c-9daf-0575f5b3fb69",
"RecordStatus": "Created",
"CreatedTs": "2023-10-03 03:00:02 -04:00",
"UpdatedTs": "2023-10-03 03:16:49 -04:00"
}
],
"ErrorRecords": null
},
"Errors": null
}