Status
Use this method to retrieve the IRS status of the 941-X returns by providing the Submission Id and Record Ids.
Federal Return Statuses:
-
Created: Form 941-X has been created and not yet transmitted by the user.
-
Transmitted: Form 941-X has been transmitted by the user.
-
Accepted: Form 941-X is accepted by the IRS.
-
Rejected: Form 941-X is rejected by the IRS due to some errors. Please correct the errors and retransmit them.
GET Form941X/Status
Request Params
Field | Type | Description |
---|---|---|
SubmissionId | Guid | Unique identifier of a submission |
RecordIds | Guid[] | List of record Ids to get status. |
ReturnType | string | Type of the return to be corrected. Enter values like FORM941, FORM941SS. Allowed values"FORM941", "FORM941SS" |
EIN | string | Employer Identification Number |
Qtr | string | Quarter of Form 941 to be corrected. Allowed valuesQ1, "Q2", "Q3", "Q4" |
TaxYr | string | Tax year of Form 941 to be corrected. Allowed values"2024" |
Request Params
"Form941X/Status?SubmissionId=7c1f1df2-61f1-4881-88d5-2a5db230e987&RecordIds=9ae8badc-d68e-4913-a050-fae80d0a9acd"
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. |
Form941Records | object | Pulls the Form 941-X records with Success and Error statuses. |
SuccessRecords | object[] | It will show the detailed information about the success status of Form 941-X Records. |
SequenceId | string | A unique number given by an inbound application to identify failed records. |
RecordId | Guid | Unique identifier of a record. |
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 941-X Records. |
RecordId | Guid | Unique identifier of a record. |
SequenceId | string | A unique number given by an inbound application to identify failed records. |
Errors | object[] | Shows detailed error information. |
Id | string | Returns the validation error id. |
Name | string | Name of the validation error. |
Message | string | Description of the validation error. |
Errors | object[] | Shows detailed error information. |
Id | string | Returns the validation error code. |
Name | string | Name of the validation error. |
Message | string | Description of the validation error. |
Response JSON
Success Response - This is a sample response for successful API requests.
{
"StatusCode": 200,
"StatusName": "Ok",
"StatusMessage": "Successful API call",
"SubmissionId": "7c1f1df2-61f1-4881-88d5-2a5db230e987",
"Form941XRecords": {
"SuccessRecords": [
{
"SequenceId": "002",
"RecordId": "9ae8badc-d68e-4913-a050-fae80d0a9acd",
"RecordStatus": "Created",
"CreatedTs": "2024-09-16 03:33:42 -04:00",
"UpdatedTs": "2024-09-16 03:35:46 -04:00",
"Errors": null
}
],
"ErrorRecords": null
},
"Errors": null
}