Extend your software with TaxBandits IRS E-file API Integration

Skip to main content
Version: 1.6.1

Status

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

GET Form940SchR/Status

Request Body

FieldTypeDescription
SubmissionIdstringUnique identifier of a submission
RecordIdsstringList of record Ids to get status.
ReturnTypestringType of the return to be filed. Enter values like FORM940, FORM940PR, FORM940SS, FORM940SCHR
EINstringEmployer Identification Number
TaxYearstringThe Tax 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
Form940SchRRecordsobjectPulls the Form 940SCHR 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.
        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.
            CRecordIdstringClient 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 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.
        ClientErrorRecordsobject[]Client Error Status.
            CSeqIdobject[]This identifies the sequence on the record sent in the pay load. When errors occur we will send the errors attached to particular sequence.
            CRecordIdobject[]Client Record Identifier
            Errorsobject[]It will show the detailed information about the error.
                CodestringIt will return the validation error code.
                NamestringIt will return the name of the validation error.
                MessagestringIt will return the detailed message of the validation error.
                TypestringIt will show the type of an 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

Form940SCHR/Status?SubmissionId=9723f666-c46e-43e6-8c56-8cba391acbf7&RecordIds=554fb9c3-b68b-4a52-9114-792cd4a70433&EIN=007820414&TaxYear=2018

Response JSON

{ "StatusCode": 200, "StatusName": "Ok", "StatusMessage": "Successful API call", "SubmissionId": "9723f666-c46e-43e6-8c56-8cba391acbf7", "Form940SchRRecords": {   "SuccessRecords": [     {       "Sequence": "",       "RecordId": "554fb9c3-b68b-4a52-9114-792cd4a70433",       "RecordStatus": "Created",       "CreatedTs": "2019-08-07 02:59:41 -04:00",       "UpdatedTs": "2019-08-07 03:24:00 -04:00",       "ClientSuccessRecords": null     }   ],   "ErrorRecords": null }, "Errors": null}