List
LIST endpoint lets you list the basic details of all the returns irrespective of their record status. List can be customized by sending values corresponding to its optional parameters, which gets applied as filters to the list.
GET FormW2/List 
Request Params
| Field | Type | Description |
|---|---|---|
| SubmissionId | Guid | Unique identifier of a submission |
| BusinessId | Guid | Unique identifier of a business |
| EIN | string | Employer Identification Number |
| TaxYear | string | List the W2 records based on the given taxyear. |
| Page | number | Pulls the records listed in the page selected |
| PageSize | number | Number of W-2 records to be listed in each page |
| EfileStatus | string | List the W-2 records based on the status ("CREATED, UNDERPROCESS, SENTTOAGENCY, TRANSMITTED, ACCEPTED, REJECTED") |
| FromDate | string | Enter a date from which the Form W2 records need to be listed in MM/DD/YYYY format. |
| ToDate | string | Enter a date till which the W2 records created are to be listed in MM/DD/YYYY format. |
Request Params
"Formw2/List?BusinessId=417be5c4-0a9a-46f1-ba41-69c39f3a90de"
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. |
| FormW2Records | object[] | Returns detailed information of the Form W-2 records |
| SubmissionId | Guid | Unique identifier of a submission |
| BusinessId | Guid | Unique identifier of a business |
| PayerRef | string | Unique identifier of a payer. |
| BusinessNm | string | Name of the business |
| EINorSSN | string | Employer Identification Number or Social Security Number |
| ContactName | string | Name of the person who can be contacted by the IRS. |
| TaxYear | string | Tax year of W-2s to be filed. |
| Employee | object | Returns the employee details. |
| 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. |
| EmployeeName | Boolean | Name of the employee. |
| SSN | string | SSN of the employee. |
| Status | string | The status of Form W2. |
| TotalRecords | number | Total number of records listed in the response. |
| TotalPages | number | Total number of pages |
| Page | number | Returns the page number in which the records are listed |
| PageSize | number | Number of records listed in each page. |
| 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",
"FormW2Records": [
{
"SubmissionId": "b1c1fca0-41d4-4be1-bfd4-3b6756c22790",
"BusinessId": "417be5c4-0a9a-46f1-ba41-69c39f3a90de",
"PayerRef": "379946",
"BusinessNm": "Snowdaze LLC",
"EIN": "52-6672586",
"ContactName": "Chandler White",
"TaxYear": "2021",
"Employee": {
"SequenceId": "01",
"RecordId": "065d46f2-4b5e-49e6-a62a-4c9d2f2f0515",
"EmployeeId": "60f86bf9-a55a-4055-9eda-d7659b3c1b2b",
"EmployeeName": "Mark Freek Linda Sr",
"FirstNm": "Mark",
"LastNm": "Linda",
"MiddleNm": "Freek",
"Suffix": "Sr",
"SSN": "266-87-3255",
"FederalReturn": {
"Status": "CREATED",
"StatusTs": "2024-06-29 03:42:26 -04:00",
"Info": null,
"Errors": null
},
"StateReturns": [
{
"StateCd": "DE",
"Status": "CREATED",
"StatusTs": "2024-06-29 03:32:31 -04:00",
"Info": null,
"Errors": null
},
{
"StateCd": "SC",
"Status": "CREATED",
"StatusTs": "2024-06-29 03:32:31 -04:00",
"Info": "You should take care of filing Form WH-1606, Fourth Quarter/Annual Withholding Tax Reconciliation Report, with the state of South Carolina. The due date to file Form WH-1606 is January 31,2024. https://dor.sc.gov/forms-site/Forms/WH1606.pdf",
"Errors": null
}
],
"Postal": {
"Status": "CREATED",
"StatusTs": "2024-06-29 03:42:26 -04:00",
"Info": null
},
"OnlineAccess": {
"Status": "CREATED",
"Email": "mark+13@sample.com",
"Info": null
}
}
},
{
"SubmissionId": "fbf4d042-0a23-42ba-9779-f9e30c4c20a4",
"BusinessId": "417be5c4-0a9a-46f1-ba41-69c39f3a90de",
"PayerRef": "379946",
"BusinessNm": "Snowdaze LLC",
"EIN": "52-6672486",
"ContactName": "Chandler White",
"TaxYear": "2021",
"Employee": {
"SequenceId": "01",
"RecordId": "a3c92259-e296-4147-8649-26ef7a68890c",
"EmployeeId": "ca383c44-22d1-4765-82de-1319b07fdba7",
"EmployeeName": "Mark Freek Linda Sr",
"FirstNm": "Mark",
"LastNm": "Linda",
"MiddleNm": "Freek",
"Suffix": "Sr",
"SSN": "266-87-3245",
"FederalReturn": {
"Status": "CREATED",
"StatusTs": "2024-06-29 03:32:31 -04:00",
"Info": null,
"Errors": null
},
"StateReturns": [
{
"StateCd": "DE",
"Status": "CREATED",
"StatusTs": "2024-06-29 03:32:31 -04:00",
"Info": null,
"Errors": null
},
{
"StateCd": "SC",
"Status": "CREATED",
"StatusTs": "2024-06-29 03:32:31 -04:00",
"Info": "You should take care of filing Form WH-1606, Fourth Quarter/Annual Withholding Tax Reconciliation Report, with the state of South Carolina. The due date to file Form WH-1606 is January 31,2024. https://dor.sc.gov/forms-site/Forms/WH1606.pdf",
"Errors": null
}
],
"Postal": {
"Status": "CREATED",
"StatusTs": "2024-06-29 03:32:31 -04:00",
"Info": null
},
"OnlineAccess": {
"Status": "CREATED",
"Email": "mark+123@sample.com",
"Info": null
}
}
}
],
"TotalRecords": 2,
"TotalPages": 1,
"Page": 1,
"PageSize": 100,
"Errors": null
}