Status
Gets the status of the 941SCHR returns by Submission Id and Record Ids.
Federal Return Statuses:
- Created: Form 941 SCHR has been created and not yet transmitted by the user.
- Transmitted: Form 941 SCHR has been transmitted by the user.
- Accepted: Form 941 SCHR is accepted by the IRS.
- Rejected: Form 941 SCHR is rejected by the IRS due to some errors. Please correct the errors and retransmit them.
GET Form941SCHR/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 filed. Enter values like FORM941, FORM941PR, FORM941SS, FORM941SCHR |
EIN | string | Employer Identification Number |
Qtr | string | Quarter of Form 941SCHR to be filed. |
TaxYear | string | Tax year of Form 941/941 SCH R to be filed. |
Request Params
"Form941SCHR/Status?SubmissionId=8e73ad5f-47c9-46b8-ae35-9f4c7432ffa9&RecordIds=d3888fc3-fee0-4020-bd6d-2a3795beff37&ReturnType=FORM941SCHR&EIN=005498751&Qtr=Q1&TaxYear=2022"
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. |
Form941SchRRecords | object | Pulls the Form 941SCHR records with Success and Error statuses |
SuccessRecords | object[] | It will show the detailed information about the success status of Form 941 Schedule R 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. |
ClientSuccessRecords | object[] | Client Success Status |
CSeqId | string | This identifies the sequence on the record sent in the payload. When errors occur we will send the errors attached to particular sequence. Required |
CRecordId | Guid | Client Record Identifier |
RecordStatus | string | Return status details like Processing, Created, Accepted, Rejected. |
CreatedTs | string | Return created date and time |
UpdatedTs | string | Return updated date and time |
ErrorRecords | object[] | It will show the detailed information about the error status of Form 941 Schedule R Records |
SequenceId | string | A unique number given by an inbound application to identify failed records. |
RecordId | Guid | Unique identifier of a record |
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. |
ClientErrorRecords | object[] | Client Error Status |
CSeqId | string | This identifies the sequence on the record sent in the payload. When errors occur we will send the errors attached to particular sequence. Required |
CRecordId | Guid | Client Record Identifier |
Errors | object[] | It will show the detailed information about the error. |
Id | string | It will return the validation error id. |
Name | string | It will return the name of the validation error. |
Message | string | It will return the detailed message of the validation error. |
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. |
Response JSON
Success Response - This is a sample response for successful API requests.
{
"StatusCode": 200,
"StatusName": "Ok",
"StatusMessage": "Successful API call",
"SubmissionId": "8e73ad5f-47c9-46b8-ae35-9f4c7432ffa9",
"Form941SchRRecords": {
"SuccessRecords": [
{
"Sequence": "1",
"RecordId": "d3888fc3-fee0-4020-bd6d-2a3795beff37",
"RecordStatus": "Created",
"CreatedTs": "2022-03-03 08:44:33 -04:00",
"UpdatedTs": "2022-03-03 09:46:54 -04:00"
}
],
"ErrorRecords": null
},
"Errors": null
}