Skip to main content
Version: 1.7.0

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 
Run in Postman

Request Params

FieldTypeDescription
SubmissionIdGuidUnique identifier of a submission
BusinessIdGuidUnique identifier of a business
EINstringEmployer Identification Number
TaxYearstringList the W2 records based on the given taxyear.
PagenumberPulls the records listed in the page selected
PageSizenumberNumber of W-2 records to be listed in each page
EfileStatusstringList the W-2 records based on the status ("CREATED, UNDERPROCESS, SENTTOAGENCY, TRANSMITTED, ACCEPTED, REJECTED")
FromDatestringEnter a date from which the Form W2 records need to be listed in MM/DD/YYYY format.
ToDatestringEnter a date till which the W2 records created are to be listed in MM/DD/YYYY format.

Request Params

FormW2/List?BusinessId=89f60812-33ba-4468-a685-d45fcaf96599&SubmissionId=2afb3723-82fa-4889-bc6d-fbd6d04b9839

Response Body

FieldTypeDescription
StatusCodenumberReturns the HTTP status codes like 200,300 etc.
StatusNamestringName of the status code.
StatusMessagestringDetailed status message.
FormW2Recordsobject[]Returns detailed information of the Form W-2 records
    SubmissionIdGuidUnique identifier of a submission
    BusinessIdGuidUnique identifier of a business
    PayerRefstringUnique identifier of a payer.
    BusinessNmstringName of the business
    EINorSSNstringEmployer Identification Number or Social Security Number
    ContactNamestringName of the person who can be contacted by the IRS.
    TaxYearstringTax year of W-2s to be filed.
    EmployeeobjectReturns the employee details.
        SequenceIdstringAn 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.
        RecordIdGuidAn unique identifier generated by TaxBandits when a W2 return is created.
        EmployeeIdGuidAn 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.
        EmployeeNameBooleanName of the employee.
        SSNstringSSN of the employee.
        StatusstringThe status of Form W2.
TotalRecordsnumberTotal number of records listed in the response.
TotalPagesnumberTotal number of pages
PagenumberReturns the page number in which the records are listed
PageSizenumberNumber of records listed in each page.
Errorsobject[]Shows detailed error information
    IdstringReturns the validation error Id
    NamestringName of the validation error
    MessagestringDescription of the validation error

Response JSON

{
"StatusCode": 200,
"StatusName": "Ok",
"StatusMessage": "Successful API call",
"FormW2Records": [
{
"SubmissionId": "2afb3723-82fa-4889-bc6d-fbd6d04b9839",
"BusinessId": "89f60812-33ba-4468-a685-d45fcaf96599",
"PayerRef": "3386",
"BusinessNm": "Snowdaze LLC",
"EIN": "52-6664385",
"ContactName": "Chandler White",
"TaxYear": "2021",
"Employee": {
"SequenceId": "01",
"RecordId": "2ff11e97-b3de-4eb5-b651-4fb4438d7c5e",
"EmployeeId": "91748dc3-6d18-4e21-8279-4d79a1adafef",
"EmployeeName": "Mark Freek Linda Sr",
"SSN": "266-87-5724",
"FederalReturn": {
"Status": "CREATED",
"StatusTs": "2024-04-08 05:49:33 -04:00",
"Info": null,
"Errors": null
},
"StateReturns": [
{
"StateCd": "DE",
"Status": "CREATED",
"StatusTs": "2024-04-08 04:06:09 -04:00",
"Info": null,
"Errors": null
},
{
"StateCd": "SC",
"Status": "CREATED",
"StatusTs": "2024-04-08 04:06:09 -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,2022. https://dor.sc.gov/forms-site/Forms/WH1606.pdf",
"Errors": null
}
],
"Postal": {
"Status": "CREATED",
"StatusTs": "2024-04-08 05:49:33 -04:00",
"Info": null
},
"OnlineAccess": {
"Status": "CREATED",
"Email": "mark@sample.com",
"Info": null
}
}
}
],
"TotalRecords": 1,
"TotalPages": 1,
"Page": 1,
"PageSize": 100,
"Errors": null
}