List

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 

Run in Postman

Request Params

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. Allowed values: "2022","2023","2024"
Page	number	Pulls the records listed in the page selected
PageSize	number	Number of W2 G records to be listed in each page. Note: PageSize can be maximum of 100.
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 in MM/DD/YYYY format.
ToDate	string	Enter a date till which the W2-G records created are to be listed in MM/DD/YYYY format.

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
FirstNm	string	First Name of the individual
MiddleNm	string	Middle Name of the Individual
LastNm	string	Last Name of the Individual
Suffix	string	Suffix of the CoveredIndividuals
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.
PayeeRef	string	A unique identifier for each payee completing their information.
RecipientNm	Boolean	Name of Recipient.
FirstNm	string	First Name of the individual
MiddleNm	string	Middle Name of the Individual
LastNm	string	Last Name of the Individual
Suffix	string	Suffix of the Individual
TIN	string	TIN of the Recipient.
FederalReturn	object	Returns the record status and StatusTs of federal return service for Form W2-G.
Status	string	Returns the record status.
StatusTs	string	Returns date and time of return created.
Info	string	Returns information about the Federal Filing service.
Errors	object[]	Shows detailed error information.
Postal	object	Returns the status and StatusTs of postal mailing service for Form W2-G.
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 status of online access for Form W2-G return.
Email	string	Email address for whom the online access to be given.
Info	string	Information about the online access service.
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 Params

"Formw2G/List?SubmissionId=1abc3bc8-a3dc-499e-9e28-f25c0c458f32"

Success Response - This is a sample response for successful API requests.

Response JSON

{
    "StatusCode": 200,
    "StatusName": "Ok",
    "StatusMessage": "Successful API call",
    "Form1099Type": "W2G",
    "Form1099Records": [
        {
            "SubmissionId": "1abc3bc8-a3dc-499e-9e28-f25c0c458f32",
            "BusinessId": "b161f84d-d38e-4d37-a2a4-ec952f8462cb",
            "PayerRef": "Pe1234",
            "BusinessNm": "Snowdaze LLC",
            "FirstNm": null,
            "LastNm": null,
            "MiddleNm": null,
            "Suffix": null,
            "IsEIN": true,
            "EINorSSN": "62-6369245",
            "ContactNm": "Chandler White",
            "TaxYear": "2024",
            "Recipient": {
                "SequenceId": "1",
                "RecordId": "6dbc5de2-1a19-4143-9a2e-1709a5610342",
                "RecipientId": "ff406310-e6bd-4538-b1cc-0354bb5c1756",
                "PayeeRef": "Payee001",
                "RecipientNm": "Stephen",
                "FirstNm": null,
                "LastNm": null,
                "MiddleNm": null,
                "Suffix": null,
                "TINType": "EIN",
                "TIN": "39-3817572",
                "FederalReturn": {
                    "Status": "CREATED",
                    "StatusTs": "2024-07-02 01:18:04 -04:00",
                    "Info": null,
                    "Errors": null
                },
                "Postal": {
                    "Status": "CREATED",
                    "StatusTs": "2024-07-01 06:46:20 -04:00",
                    "Info": null
                },
                "OnlineAccess": {
                    "Status": "CREATED",
                    "Email": "mark+32@sample.com",
                    "Info": null
                },
                "ScheduleFiling": {
                    "ScheduledOn": null,
                    "Info": "This Service will be available soon"
                }
                
            }
        }
    ],
    "Page": 1,
    "TotalRecords": 1,
    "TotalPages": 1,
    "PageSize": 100,
    "Errors": null
}