Extend your software with TaxBandits IRS E-file API Integration

Skip to main content
Version: 1.6.1

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

Request Body

FieldTypeDescription
SubmissionIdGuidUnique identifier of a submission
BusinessIdGuidUnique identifier of a business
TINTypestringList the W2 G records based on the given TINType and TIN.
TINstringList the W2 G records based on the given TIN.
TaxYearstringList the W2 G records based on the given taxyear.
PagenumberPulls the records listed in the page selected
PageSizenumberNumber of W2 G records to be listed in each page.
EfileStatusstringList the W2 G records based on the status ("CREATED, UNDERPROCESS, SENTTOAGENCY, TRANSMITTED, ACCEPTED, REJECTED")
FromDatestringEnter a date from which the Form W2-G records need to be listed.
ToDatestringEnter a date till which the W2-G records created are to be listed.

Response Body

FieldTypeDescription
StatusCodenumberReturns the HTTP status codes like 200,300 etc.
StatusNamestringName of the status code
StatusMessagestringDetailed status message
Form1099TypestringDenotes the type of W2G form.
Form1099Recordsobject[]Returns detailed information of the Form W2 G records.
    SubmissionIdGuidUnique identifier of a submission
    BusinessIdGuidUnique identifier of a business
    PayerRefstringUnique identifier of the payer.
    BusinessNmstringName of the business
    IsEINBooleanWhen true, identifies the business with an EIN.
    EINorSSNstringWhen IsEIN is true, use Employer Identification Number (EIN). When IsEIN is false, use Social Security Number (SSN)
    ContactNmstringContact Name of the Business.
    TaxYearstringTax year of W2 G to be filed.
    RecipientobjectDetails of the Recipient.
        SequenceIdstringA 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.
        RecordIdGuidA unique identifier generated by TaxBandits when a W2-G return is created.
        RecipientIdGuidA 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.
        RecipientNmBooleanName of Recipient.
        TINTypestringTIN type of the Recipient.
        TINstringTIN of the Recipient.
        StatusstringThe status of Form W2 G.
PagenumberPulls the records listed in the page selected
TotalRecordsnumberTotal number of records.
TotalPagesnumberTotal number of pages.
PageSizenumberNumber of 1099 G records to be listed in each page.
Errorsobject[]Shows detailed error information
    IdstringReturns the validation error id
    NamestringName of the validation error
    MessagestringDescription 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}