Extend your software with TaxBandits IRS E-file API Integration

Skip to main content
Version: 1.7.1

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 Body

FieldTypeDescription
SubmissionIdGuidUnique identifier of a submission
RecordIdsGuid[]Unique identifier of a record

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.
Form941RecordsobjectPulls the Form 941 records with Success and Error statuses.
    SuccessRecordsobject[]It will show the detailed information about the success status of Form 941 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 941 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.

Request JSON: 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 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}