List

List

Lists all Form W-2G correction returns created and transmitted on the account for a particular Submission or Payer. The response will include a list of W-2G correction forms filtered according to the criteria provided in the request.

GET FormW2GCorrection/List 

Run in Postman

Request Params

Field	Type	Description
SubmissionId	Guid	Unique Identifier of a Submission. Use this node if you want to list the W-2G correction records created under a Submission. Ignore this node if you want to list the records of a particular Payer.
BusinessId	Guid	This is a Unique Identifier of a Payer. Use this node if you want to list all the W-2G correction records created under the Payer. Ignore this node, if you want to list the records for a Submission.
PayerRef	string	An unique identifier for each payer completing their information. Use this node if you want to list all the W-2G correction records created under the payer reference. Ignore this node, if you want to list the records for a Submission. Size Range: ..50
TIN	string	Employer Identification Number or Social Security Number of the Payer is required only when you have not provided the SubmissionId or the BusinessId.
TaxYear	string	Enter the specific tax year for the list of W-2G correction records. If the tax year is not given; all tax year records will be listed.
RecipientId	Guid	Optional Unique ID generated for each recipient after the return is created and returned in the Response.
PayeeRef	string	A unique identifier for each recipient. Size Range: 1-50
RecipientNm	string	Name of the recipient Size Range: ..75
RecipientTIN	string	TIN of the recipient (Either EIN or SSN) Size Range: 9-11
MaskedTIN	string	Last four digits of the recipient TIN Size Range: 4
Page	number	Mention the page number that needs to be listed in the Response. If the value is not given, the page will be defaulted to 1.
PageSize	number	Provide a numerical value to list the total number of Form W-2G correction records in each page. If the value is not given, then the page size will be defaulted to 1000. Note: PageSize can be maximum of 100.
EfileStatus	string	Mention Form W-2G correction record status that needs to be listed. If the value is not given, then records with all the statuses will be listed.
FromDate	string	Enter a date from which the Form W-2G correction records need to be listed in MM/DD/YYYY format.
ToDate	string	Enter a date till which the W-2G correction 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	Submission Status
StatusMessage	string	Status Details
Form1099Type	string	Denotes the type of 1099 form.
FormW2GRecords	object[]	It contains list of W-2G correction records.
SubmissionId	Guid	Unique Identifier of a Payer.
BusinessId	Guid	Unique identifier of a business.
BusinessNm	string	Payer's Name.
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
EINorSSN	string	Payer's EIN or SSN or Payer's Employer Identification Number or Social Security Number
ContactNm	string	Contact Name of the Payer.
TaxYear	string	Tax year of the W-2G correction records.
Recipient	object	Recipient Details.
SequenceId	string	Sequence ID of the W-2G correction record provided during CREATE or UPDATE
RecordId	Guid	Unique identifier of the W-2G correction record.
RecipientId	Guid	Unique identifier of the Recipient.
RecipientNm	Boolean	Recipient's Name.
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
TINType	string	Recipient's TIN Type.
TIN	string	Recipient's TIN.
Status	string	Record Status of Form W-2G correction.
FederalReturn	object	Returns the record status and StatusTs of federal return.
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 error information of federal returns of Form W-2G correction.
StateReturns	object[]	Returns collection of state returns information
Postal	object	Returns the status and StatusTs of postal mailing service for Form W-2G correction.
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 W-2G correction return.
Email	string	Email address for whom the online access to be given.
Info	string	Information about the online access service.
TotalRecords	number	Total records.
TotalPages	number	Total pages.
Page	number	List of records mentioned in the request
PageSize	number	Total W-2G correction records in the page
Errors	object[]	Shows error details
Id	string	Returns the validation error ID
Name	string	Name of the validation error
Message	string	Validation error details

Request Params

"FormW2GCorrection/List?SubmissionId=94677293-8ecf-443b-8a76-8b8d192b2cb1&BusinessId=794451d1-909a-4ffa-852a-fa567b391e15&EfileStatus=ALL&FromDate=12-01-2025&ToDate=12-01-2025&Page=1&PageSize=10"

Response Json

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

{
    "StatusCode": 200,
    "StatusName": "Ok",
    "StatusMessage": "Successful API call",
    "Form1099Type": "W2GCORRECTION",
    "FormW2GRecords": [
        {
            "SubmissionId": "94677293-8ecf-443b-8a76-8b8d192b2cb1",
            "BusinessId": "794451d1-909a-4ffa-852a-fa567b391e15",
            "PayerRef": "Snow1234",
            "BusinessNm": "Snowdaze LLC",
            "IsEIN": true,
            "FirstNm": null,
            "LastNm": null,
            "MiddleNm": null,
            "Suffix": null,
            "EINorSSN": "65-7369245",
            "ContactNm": null,
            "TaxYear": "2025",
            "Recipient": {
                "SequenceId": "001",
                "RecordId": "97c9ba31-c244-4aeb-addc-f1b53be373fc",
                "PrevReportedRecordId": "f9e184a3-579a-4545-a49b-b0e9da0b8199",
                "RecipientId": "815caa44-521e-48b4-a312-39ae5b15f148",
                "RecipientNm": "Dairy Delights LLC Coco Milk",
                "FirstNm": null,
                "LastNm": null,
                "MiddleNm": null,
                "Suffix": null,
                "TINType": "EIN",
                "TIN": "39-3817983",
                "PayeeRef": null,
                "Status": "CREATED",
                "FederalReturn": {
                    "Status": "CREATED",
                    "StatusTs": "2025-12-01 05:30:17 -05:00",
                    "Info": null,
                    "Errors": null
                },
                "StateReturns": [
                    {
                        "StateCd": "CA",
                        "Status": "CREATED",
                        "StatusTs": "2025-12-01 05:30:17 -05:00",
                        "Info": null,
                        "Errors": null
                    },
                    {
                        "StateCd": "AL",
                        "Status": "CREATED",
                        "StatusTs": "2025-12-01 05:30:17 -05:00",
                        "Info": null,
                        "Errors": null
                    }
                ],
                "Postal": {
                    "Status": "CREATED",
                    "StatusTs": "2025-12-01 05:30:17 -05:00",
                    "Info": null
                },
                "OnlineAccess": {
                    "Status": "NA",
                    "Email": null,
                    "Info": "This Service will be available soon"
                }
            }
        }
    ],
    "Page": 1,
    "TotalRecords": 1,
    "TotalPages": 1,
    "PageSize": 100,
    "Errors": null
}