Skip to main content
Version: 1.7.3

Status

Status

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

Federal Return Statuses:

  • Created: Form 940 has been created and not yet transmitted by the user.
  • Transmitted: Form 940 has been transmitted by the user.
  • Accepted: Form 940 is accepted by the IRS.
  • Rejected: Form 940 is rejected by the IRS due to some errors. Please correct the errors and retransmit them.
GET Form940/Status 
Run in Postman

Request Params

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.
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.
        PayerRefstringUnique identifier of the payer.
        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 Params

"Form940/Status?SubmissionId=adfaa49c-58c7-4e66-a2df-1258dad0a3e1&Recordids=9657e565-c91c-455e-ac2b-d9ef18d19db6"

Response JSON

Success Response - This is a sample response for successful API requests.

{
"StatusCode": 200,
"StatusName": "Ok",
"StatusMessage": "Successful API call",
"SubmissionId": "adfaa49c-58c7-4e66-a2df-1258dad0a3e1",
"Form940Records": {
"SuccessRecords": [
{
"SequenceId": null,
"BusinessId": "906476cb-89da-48d3-97d9-90106114e4bf",
"PayerRef": "Snow001",
"RecordId": "9657e565-c91c-455e-ac2b-d9ef18d19db6",
"RecordStatus": "Created",
"CreatedTs": "2025-03-20 05:26:20 -04:00",
"UpdatedTs": "2025-03-20 05:27:56 -04:00",
"Errors": null
}
],
"ErrorRecords": null
},
"Errors": null
}