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
Request Params
Field | Type | Description |
---|---|---|
SubmissionId | string | Unique identifier of a submission |
RecordIds | string | Gets the status for a list of Record IDs |
ReturnType | string | Type of the return to be filed. Enter values like FORM940, FORM940PR. |
EIN | string | Employer Identification Number |
TaxYear | string | Tax year for which Form 940/940 SCH R needs to be filed |
Response Body
Field | Type | Description |
---|---|---|
StatusCode | number | Returns the HTTP status codes like 200,300 etc. |
StatusName | string | Name of the status code. |
StatusMessage | string | Detailed status message. |
SubmissionId | Guid | Unique identifier of a submission. |
Form940Records | object | Pulls the Form 940 records with Success and Error statuses. |
SuccessRecords | object[] | It will show the detailed information about the success status of Form 940 Records. |
Sequence | string | A unique number given by an inbound application to identify failed records. |
RecordId | Guid | Unique identifier of a record. |
PayerRef | string | Unique identifier of the payer. |
RecordStatus | string | Returns the status of the records. |
CreatedTs | string | Date and time of return created. |
UpdatedTs | string | Date and time of return updated. |
ErrorRecords | object[] | It will show the detailed information about the error status of Form 940 Records |
RecordId | Guid | Unique identifier of a record. |
Sequence | string | A unique number given by an inbound application to identify failed records. |
Errors | object[] | Shows detailed error information. |
Code | string | Returns the validation error code. |
Name | string | Name of the validation error. |
Message | string | Description of the validation error. |
Type | string | Type of validation error. |
Errors | object[] | Shows detailed error information. |
Code | string | Returns the validation error code. |
Name | string | Name of the validation error. |
Message | string | Description of the validation error. |
Type | string | Type 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
}