Extend your software with TaxBandits IRS E-file API Integration

Skip to main content
Version: 1.6.1

Status

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

GET Form940/Status

Request Body

FieldTypeDescription
SubmissionIdstringUnique identifier of a submission
RecordIdsstringGets the status for a list of Record IDs
ReturnTypestringType of the return to be filed. Enter values like FORM940, FORM940PR, FORM940SS, FORM940SCHR
EINstringEmployer Identification Number
TaxYearstringTax year for which Form 940/940 SCH R needs to be filed

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.
Form940RecordsobjectPulls the Form 940 records with Success and Error statuses.
    SuccessRecordsobject[]It will show the detailed information about the success status of Form 940 Records.
        SequencestringA 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 940 Records
        RecordIdGuidUnique identifier of a record.
        SequencestringA unique number given by an inbound application to identify failed records.
        Errorsobject[]Shows detailed error information.
            CodestringReturns the validation error code.
            NamestringName of the validation error.
            MessagestringDescription of the validation error.
            TypestringType of validation error.
Errorsobject[]Shows detailed error information.
    CodestringReturns the validation error code.
    NamestringName of the validation error.
    MessagestringDescription of the validation error.
    TypestringType of validation error.

Request JSON

Form940/Status?SubmissionId=7f9cb1ab-f90b-4358-ae5f-acfe19617d96&RecordIds=22af7b4b-42f2-4e68-a9ac-743d2fd76636&ReturnType=FORM940&EIN=005498751&TaxYear=2018

Response JSON

{ "StatusCode": 200, "StatusName": "Ok", "StatusMessage": "Successful API call", "SubmissionId": "7f9cb1ab-f90b-4358-ae5f-acfe19617d96", "Form940Records": {   "SuccessRecords": [     {       "Sequence": null,       "RecordId": "22af7b4b-42f2-4e68-a9ac-743d2fd76636",       "RecordStatus": "Created",       "CreatedTs": "2019-08-06 01:29:56 -04:00",       "UpdatedTs": "2019-08-06 01:29:56 -04:00"     }   ],   "ErrorRecords": null }, "Errors": null}