Status
This method will return the current status of the Form W-2 for a particular submission or for a particular employee.
Federal Return Statuses:
Created: Form W-2 has been created and not yet transmitted by the user.
Transmitted: Form W-2 has been transmitted by the user.
Order Received: Form W-2 order is received and waiting in our efile queue.7
Under Process: Our efile system is processing the Form W-2 which will be sent to the SSA soon.
Sent to Agency: Form W-2 has been sent to the SSA and we are waiting for the result from SSA.
Accepted: Form W-2 is accepted by the SSA.
Rejected: Form W-2 is rejected by the SSA due to some errors. Please correct the errors and retransmit them.
State Return Statuses:
Not Created: State filing is not opted for the return. IsStateFiling in the submission manifest must be set as TRUE to enable state filing.
Created: Form W-2 state return has been created and not yet transmitted by the user.
Transmitted: Form W-2 state return has been transmitted by the user.
Order Received: State order is received and waiting in our efile queue.
Under Process: Our efile system is processing the Form W-2 for the state which will be sent to the state DOR soon.
Sent to Agency: Form W-2 State return has been sent to the DOR and we are waiting for the result.
Accepted: Form W-2 state return is accepted by the DOR.
Rejected: Form W-2 state return is rejected by the DOR due to some errors. Please correct the errors and retransmit them.
Postal Mailing Statuses:
Not Created: Postal Mailing is not opted for the return. IsPostalMailing in the submission manifest must be set as TRUE to enable postal mailing. Postal Mailing cannot be created for employees with Foreign addresses.
Created: Postal Mailing service is opted for the return and it will be sent as soon as the form is transmitted.
Order Received: Postal Mailing order has been received and the mails will be sent out soon.
Order Sent: Postal Mailing order has been sent and the employee will receive the copy soon.
Online Access Statuses:
Not Created: Online Access service is not opted for the return. IsOnlineAccess in the submission manifest must be set as TRUE to enable Online Access. Email Address is required to create Online Access.
Created: Online Access service is opted for the return and the email with a secure link to download their forms will be sent to the employees as soon as the form is transmitted.
Order Received: Online Access order has been received and the email will be sent to the employee soon.
Email Sent: Online Access email with a secure link to download the form has been sent to the employee and the employee is yet to view the form.
Viewed Form: Employee has successfully viewed the form.
Downloaded Form: Employee has successfully viewed and downloaded the form.
GET FormW2/Status
Request Body
| Field | Type | Description |
|---|---|---|
| SubmissionId | Guid | Unique identifier of a submission |
| RecordIds | Guid[] | Number of record Ids to get status. |
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 |
| BusinessId | Guid | Unique identifier of a Business. |
| PayerRef | string | Unique identifier of a Payer. |
| FormW2Records | object | Pulls the Form W-2 records with Success and Error statuses |
| SuccessRecords | object[] | It will show the detailed information about the success status of Form W2 Records |
| SequenceId | string | An unique reference ID for the submission that can be used to identify a particular record. The Sequence ID will be returned in the Response for your reference. |
| RecordId | Guid | An unique identifier generated by TaxBandits when a W2 return is created. |
| EmployeeId | Guid | An unique identifier generated by TaxBandits for a employee when a W2 return is created. You can use this id for your future reference to Update. |
| FederalReturn | object | Returns the record status and StatusTs of federal return. |
| Status | string | Returns the record status. |
| StatusTs | string | Returns date and time of return created. |
| Info | string | Returns information about the Federal Filing service. |
| StateReturns | object[] | Returns collection of state returns information |
| StateCd | string | Returns the state code of the state for which the return is filed. |
| Status | string | Returns the record status of the state return. |
| StatusTs | string | Date and time of the return created. |
| Info | string | Returns the information about the state for which we are not supporting state filing. |
| Errors | object[] | Shows error information of state returns of Form W2 |
| Id | string | Returns the validation error Id. |
| Name | string | Name of the validation error. |
| Message | string | Description of the validation error. |
| Postal | object | Returns the status and StatusTs of postal mailing service for Form W2. |
| Status | string | Returns the status of postal order. |
| StatusTs | string | Returns the date and time of the postal order created. |
| Info | string | Returns the information about Postal mailing service. |
| OnlineAccess | object | Returns the Email address for whom the online access to be given and Status of online access. |
| Status | string | Returns the Status of the Online Access. |
| string | Email address for whom the online access to be given. | |
| Info | string | Information about the online access service. |
| ScheduleFiling | object | Returns the date of the schedule filing. |
| ScheduledOn | string | Date of the schedule filing to know when the return to be filed to the IRS. |
| Info | string | Information about Schedule Filing service. |
| ErrorRecords | object[] | It will show the detailed information about the error status of Form W2 Records. |
| SequenceId | string | An unique reference ID for the submission that can be used to identify a particular record. The Sequence ID will be returned in the Response for your reference. |
| 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 |
| 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 |
Request JSON
FormW2/Status?SubmissionId=d1f9cb0a-912f-4105-8bcf-059af43d2b31&RecordIds=63842ea1-93ac-4e5f-a3b2-df59c2d147c5
Response JSON
{
"StatusCode": 200,
"StatusName": "Ok",
"StatusMessage": "Successful API call",
"SubmissionId": "d1f9cb0a-912f-4105-8bcf-059af43d2b31",
"BusinessId": "62ac9c76-4fa8-4459-8a7d-e9763862d5fa",
"PayerRef": "Pe123",
"FormW2Records": {
"SuccessRecords": [
{
"SequenceId": "001",
"RecordId": "63842ea1-93ac-4e5f-a3b2-df59c2d147c5",
"EmployeeId": "ad035610-bfc0-494b-a3f0-5eeaf51408ec",
"FederalReturn": {
"Status": "CREATED",
"StatusTs": "2021-11-20 15:02:51 +05:30",
"Info": null
},
"StateReturns": [
{
"StateCd": "IN",
"Status": "State Filing Order Received",
"StatusTs": "2021-08-06 10:32:40 -04:00",
"Info": null,
"Errors": null
},
{
"StateCd": "VT",
"Status": "State Filing Order Received",
"StatusTs": "2021-08-06 10:32:40 -04:00",
"Info": null,
"Errors": null
},
{
"StateCd": "PA",
"Status": "State Filing Order Received",
"StatusTs": "2021-08-06 10:32:40 -04:00",
"Info": null,
"Errors": null
},
{
"StateCd": "KS",
"Status": "State Filing Order Received",
"StatusTs": "2021-08-06 10:32:40 -04:00",
"Info": null,
"Errors": null
}
],
"Postal": {
"Status": "NOTCREATED",
"StatusTs": null,
"Info": "Postal Alert cannot be opted for the return, when the employee (or) business has foreign address"
},
"OnlineAccess": {
"Status": "CREATED",
"Email": "john@gmail.com",
"Info": null
},
"ScheduleFiling": null
}
],
"ErrorRecords": null
},
"Errors": null
}