Status
Gets the status of the 943 returns by Submission Id and Record Ids.
GET Form943/Status
Request Parameters
Field | Type | Description |
---|---|---|
SubmissionId | string | Unique identifier of a submission |
RecordIds | string | Optional Gets the status for a list of Record IDs |
ReturnType | string | Optional Type of the return to be filed. Enter value as FORM943 |
EIN | string | Optional Employer Identification Number |
TaxYear | string | Optional Tax year for which Form 943 needs to be filed |
Response Parameters
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. |
Form943Records | object | Pulls the Form 943 records with Success and Error statuses. |
SuccessRecords | object[] | It will show the detailed information about the success status of Form 943 Records. |
Sequence | 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 943 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 JSON
Form943/Status?SubmissionId=7f9cb1ab-f90b-4358-ae5f-acfe19617d96&RecordIds=22af7b4b-42f2-4e68-a9ac-743d2fd76636&ReturnType=FORM943&EIN=005498751&TaxYear=2019
Response JSON
{
"StatusCode": 200,
"StatusName": "Ok",
"StatusMessage": "Successful API call",
"SubmissionId": "7f9cb1ab-f90b-4358-ae5f-acfe19617d96",
"Form943Records": {
"SuccessRecords": [
{
"Sequence": null,
"RecordId": "22af7b4b-42f2-4e68-a9ac-743d2fd76636",
"RecordStatus": "Created",
"CreatedTs": "2020-02-02 01:29:56 -04:00",
"UpdatedTs": "2020-02-02 01:29:56 -04:00"
}
],
"ErrorRecords": null
},
"Errors": null
}