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 FormW2C/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 W2C records based on the given taxyear.
Page	number	Pulls the records listed in the page selected
PageSize	number	Number of W-2C records to be listed in each page
EfileStatus	string	List the W-2C records based on the status ("CREATED, UNDERPROCESS, TRANSMITTED, ACCEPTED, REJECTED")
FromDate	string	Enter a date from which the Form W-2C records need to be listed in MM/DD/YYYY format.
ToDate	string	Enter a date till which the W-2C records created are to be listed in MM/DD/YYYY format.

Request Params

"FormW2C/List?SubmissionId=08a8d549-2d78-4feb-b18d-f4aded533ab3&BusinessId=5607b044-6809-4399-9645-d20d761b5dcb&EIN=441111211&TaxYear=2021&Page=1&PageSize=10&EfileStatus=ALL&FromDate=11-01-2021&ToDate=11-30-2021"

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.
FormW2CRecords	object[]	Returns detailed information of the Form W-2C records
SubmissionId	Guid	Unique identifier of a submission
BusinessId	Guid	Unique identifier of a business
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-2Cs 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 W2C return is created.
EmployeeId	Guid	An unique identifier generated by TaxBandits for a employee when a W2C 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",
   "FormW2CRecords": [
       {
           "SubmissionId": "08a8d549-2d78-4feb-b18d-f4aded533ab3",
           "BusinessId": "5607b044-6809-4399-9645-d20d761b5dcb",
           "BusinessNm": "Snowdaze LLC",
           "EIN": "44-1111211",
           "ContactName": "Brian O Relly",
           "TaxYear": "2021",
           "Employee": {
               "SequenceId": "001",
               "RecordId": "ae53c621-ea01-4cb5-9e4e-a96987a4eeb1",
               "EmployeeId": "8957652a-7877-4db8-80a5-b555e44c7354",
               "EmployeeName": "Michael John Augustin",
               "SSN": "112-23-6003",
               "Status": "CREATED"
           }
       }
   ],
   "TotalRecords": 1,
   "TotalPages": 1,
   "Page": 1,
   "PageSize": 100,
   "Errors": null
}