List
Lists all Form W2-G returns created and transmitted on the account for a particular Submission or Payer. Form W2-G returns will be listed based on the filters sent in the Request.
GET FormW2G/List
Request Body
Field | Type | Description |
---|---|---|
SubmissionId | Guid | Unique identifier of a submission |
BusinessId | Guid | Unique identifier of a business |
TINType | string | List the W2 G records based on the given TINType and TIN. |
TIN | string | List the W2 G records based on the given TIN. |
TaxYear | string | List the W2 G records based on the given taxyear. |
Page | number | Pulls the records listed in the page selected |
PageSize | number | Number of W2 G records to be listed in each page. |
EfileStatus | string | List the W2 G records based on the status ("CREATED, UNDERPROCESS, SENTTOAGENCY, TRANSMITTED, ACCEPTED, REJECTED") |
FromDate | string | Enter a date from which the Form W2-G records need to be listed. |
ToDate | string | Enter a date till which the W2-G records created are to be listed. |
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 |
Form1099Type | string | Denotes the type of W2G form. |
Form1099Records | object[] | Returns detailed information of the Form W2 G records. |
SubmissionId | Guid | Unique identifier of a submission |
BusinessId | Guid | Unique identifier of a business |
PayerRef | string | Unique identifier of the payer. |
BusinessNm | string | Name of the business |
IsEIN | Boolean | When true, identifies the business with an EIN. |
EINorSSN | string | When IsEIN is true, use Employer Identification Number (EIN). When IsEIN is false, use Social Security Number (SSN) |
ContactNm | string | Contact Name of the Business. |
TaxYear | string | Tax year of W2 G to be filed. |
Recipient | object | Details of the Recipient. |
SequenceId | string | A 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 | A unique identifier generated by TaxBandits when a W2-G return is created. |
RecipientId | Guid | A unique identifier generated by TaxBandits for a Recipient when a W2-G return is created. You can use this id for your future reference to Update. |
RecipientNm | Boolean | Name of Recipient. |
TINType | string | TIN type of the Recipient. |
TIN | string | TIN of the Recipient. |
Status | string | The status of Form W2 G. |
Page | number | Pulls the records listed in the page selected |
TotalRecords | number | Total number of records. |
TotalPages | number | Total number of pages. |
PageSize | number | Number of 1099 G records to be 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 |
Request JSON
"FormW2G/List?SubmissionId=05c4cfa0-aac5-491c-b5c3-95630933d3e7&BusinessId=8d6e3938-2af4-41d2-ba02-17796f00aae2&TINType=EIN&TIN=049133861&TaxYear=2021&Page=1&PageSize=10&EfileStatus=ALL&FromDate=11-01-2021&ToDate=11-30-2021"
Response JSON
{
"StatusCode": 200,
"StatusName": "Ok",
"StatusMessage": "Successful API call",
"Form1099Type": "W2G",
"Form1099Records": [
{
"SubmissionId": "05c4cfa0-aac5-491c-b5c3-95630933d3e7",
"BusinessId": "8d6e3938-2af4-41d2-ba02-17796f00aae2",
"PayerRef": "8965",
"BusinessNm": "Nidok Kodak Com",
"IsEIN": true,
"EINorSSN": "04-9133861",
"ContactNm": "John Kaiser",
"TaxYear": "2021",
"Recipient": {
"SequenceId": "1",
"RecordId": "1ece3ab0-381e-401d-81eb-93f500f9b493",
"RecipientId": "f8e1b653-dd6a-4400-899f-7be88100e25f",
"RecipientNm": "Mark Davis",
"TINType": "EIN",
"TIN": "39-3817572",
"Status": "CREATED"
}
}
],
"Page": 1,
"TotalRecords": 1,
"TotalPages": 1,
"PageSize": 100,
"Errors": null
}