Extend your software with TaxBandits IRS E-file API Integration

Skip to main content
Version: 1.7.1

Status

Gets the status of the 941 returns by Submission Id and Record Ids.

GET Form941/Status

Request Body

FieldTypeDescription
SubmissionIdGuidUnique identifier of a submission
RecordIdsGuid[]List of record Ids to get status.
ReturnTypestringType of the return to be filed. Enter values like FORM941, FORM941PR, FORM941SS.
Allowed values: "FORM941", "FORM941PR", "FORM941SS"
EINstringEmployer Identification Number
QtrstringQuarter of Form 941 to be filed.
Allowed values: "Q1"
TaxYrstringTax year of Form 941 to be filed.
Allowed values: "2022"

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 code.
    NamestringName of the validation error.
    MessagestringDescription of the validation error.

Request JSON

Form941/Status?SubmissionId=f2fee2f8-74bf-4e1d-9239-399e76929475&RecordIds=ed6bc24b-189d-419b-9224-2dd2bf3b7467&ReturnType=FORM941&EIN=005534958&Qtr=Q1&TaxYear=2022

Response JSON

{ "StatusCode": 200, "StatusName": "Ok", "StatusMessage": "Successful API call", "SubmissionId": "f2fee2f8-74bf-4e1d-9239-399e76929475", "Form941Records": {   "SuccessRecords": [     {       "SequenceId": "01",       "RecordId": "ed6bc24b-189d-419b-9224-2dd2bf3b7467",       "RecordStatus": "Created",       "CreatedTs": "2022-03-02 03:06:07 -04:00",       "UpdatedTs": "2022-03-02 03:46:54 -04:00"     }   ],   "ErrorRecords": null }, "Errors": null}