Extend your software with TaxBandits IRS E-file API Integration

Skip to main content
Version: 1.7.1

Validate

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

GET Form941SCHR/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.
Form941SchRRecordsobjectPulls the Form 941SCHR records with Success and Error statuses
    SuccessRecordsobject[]It will show the detailed information about the success status of Form 941 Schedule R 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.
        ClientSuccessRecordsobject[]Client Success Status
            CSeqIdstringThis identifies the sequence on the record sent in the pay load. When errors occur we will send the errors attached to particular sequence. Required
            CRecordIdGuidClient Record Identifier
            RecordStatusstringReturn status details like Processing, Created, Accepted, Rejected.
            CreatedTsstringReturn created date and time
            UpdatedTsstringReturn updated date and time
    ErrorRecordsobject[]It will show the detailed information about the error status of Form 941 Schedule R Records
        SequenceIdstringA unique number given by an inbound application to identify failed records.
        RecordIdGuidUnique identifier of a record
        Errorsobject[]Shows detailed error information.
            IdstringReturns the validation error id.
            NamestringName of the validation error.
            MessagestringDescription of the validation error.
        ClientErrorRecordsobject[]Client Error Status
            CSeqIdstringThis identifies the sequence on the record sent in the pay load. When errors occur we will send the errors attached to particular sequence. Required
            CRecordIdGuidClient Record Identifier
            Errorsobject[]It will show the detailed information about the error.
                IdstringIt will return the validation error id.
                NamestringIt will return the name of the validation error.
                MessagestringIt will return the detailed message 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

Form941SCHR/Validate?SubmissionId=380128d7-1686-4d69-883e-5f613b125ad7&RecordIds=fc66b618-5a29-428f-9ac3-04957202cbc7

Response JSON

{   "StatusCode": 200,   "StatusName": "Ok",   "StatusMessage": "Successful API call",   "SubmissionId": "380128d7-1686-4d69-883e-5f613b125ad7",   "Form941SchRRecords": {       "SuccessRecords": [           {               "SequenceId": "101",               "RecordId": "fc66b618-5a29-428f-9ac3-04957202cbc7",               "RecordStatus": "Created",               "CreatedTs": "2022-03-02 08:53:11 -05:00",               "UpdatedTs": "2022-03-02 09:14:35 -05:00",               "ClientSuccessRecords": null           }       ],       "ErrorRecords": null   },   "Errors": null}