Extend your software with TaxBandits IRS E-file API Integration

Skip to main content
Version: 1.6.1

Get

Get#

Retrieves the Form W2-G return information based on the Submission Id and RecordIds given in the request.

GET FormW2G/Get

Request Body

FieldTypeDescription
SubmissionIdGuidA unique identifier generated by TaxBandits when a W2-G return is created. Mention the Form W2-G return's Submission Id that you want to get.
RecordIdsGuid[]A unique identifier generated by TaxBandits when a W2-G return is created. Mention the Form W2-G return's Record Id that you want to get.

Response Body

FieldTypeDescription
StatusCodenumberReturns the HTTP status codes like 200,300 etc.
StatusNamestringName of the status code
StatusMessagestringDetailed status message
FormW2GRecordsobjectContains information about Form W2-G returns.
SubmissionManifestobjectSubmissionManifest provides the brief information about a particular submission on the whole. It contains information like Submission ID, Tax Year, IsPostal, IsFederalFiling, IsTinMatching, IsStateFiling, IsOnlineAccess, IsScheduleFiling & ScheduleFiling service details.
    SubmissionIdGuidUnique identifier created by TaxBandits for each submission. Not required when you are creating a return.
    TaxYearstringTax year of Form W-2G to be filed.
Allowed values: "2021"
    IsFederalFilingBooleanFederal Filing for the return will be enabled when the value is True. Form W-2G will be sent directly to the IRS.
    IsStateFilingBooleanState Filing for the return will be enabled when the value is True. Form W-2G will be directly filed with the respective recipient states. Note: State Filing will not be created for the states that do not require State filing.
    IsPostalBooleanPostal Order will be created when the value is set as True. Once the return is Transmitted, Form W-2G Recipient copies will be postal mailed to the recipient's address via USPS. Note: Postal Orders for Foreign Address will not be created.
    IsOnlineAccessBooleanOnline Access will be enabled when the value is set as True. Once the return is Transmitted, an email with the link to the secure TaxBandits portal will be sent to the Recipient. The recipient can provide consent and download Form W-2G Recipient copies from the portal.
    IsScheduleFilingBooleanWhen true, schedule filing services will be provided for Form W-2G returns under this submission.
    ScheduleFilingobjectContains preferred date to submit the returns to the IRS. Required only when "IsScheduleFiling" is True.
        EfileDatestringDate of Schedule Filing. Enter the date in the format: MM/DD/YYYY or MM-DD-YYYY Example: 10/20/2021 or 10-20-2021
ReturnHeaderobjectContains information about the Business details.
    BusinessobjectObject to identify the Business Details.
        BusinessIdGuidOptional Use the unique Business ID (Generated by TaxBandits), you received in the response of the Business CREATE Endpoint. If you have do not have a Business ID, ignore the field. By giving the Business ID, you do not have to provide all the business information again.
        BusinessNmstringName of the business
Size Range: ..80
        PayerRefstringOptional An unique identifier for each payer completing their information. This identifier can be used in future references of the payer in the API.
Size Range: ..50
        TradeNmstringOptional Name under which the business operates
Size Range: ..80
        IsEINBooleanWhen true, identify that the business TIN is an EIN.
        EINorSSNstringWhen IsEIN is true, use Employer Identification Number (EIN). When IsEIN is false, use Social Security Number (SSN)
Size Range: 9
        EmailstringEmail address of the Business
Size Range: ..40
        ContactNmstringOptional Name of the person who can be contacted by the IRS.
Size Range: ..27
        PhonestringPhone number of the business
Size Range: 10
        PhoneExtnstringOptional Extension of the business phone number
Size Range: ..5
        FaxstringOptional Fax number of the Business
Size Range: 10
        BusinessTypestringOptional Type of business. Optional for W-2/1099 and mandatory for 94X series
Size Range: 4
Allowed values: "ESTE", "PART", "CORP", "EORG", "SPRO"
        SigningAuthorityobjectOptional Details of the person who is authorized to sign the return
            NamestringOptional Name of the signing authority
Size Range: ..35
            PhonestringOptional Phone number of the signing authority
Size Range: 10
            BusinessMemberTypestringOptional Business title of the signing authority
Size Range: 5..29
Allowed values: "CORPORATESECRETARY", "SECRETARYTREASURER", "PARTNER", "GENERALPARTNER", "LIMITEDPARTNER", "LLCMEMBER", "MANAGINGMEMBER", "MANAGER", "TAXMATTERPARTNER", "PRESIDENT", "VICEPRESIDENT", "CORPORATETREASURER", "TREASURER", "ASSISTANTTREASURER", "CHIEFACCOUNTINGOFFICER", "CHIEFEXECUTIVEOFFICER", "CHIEFFINANCIALOFFICER", "TAXOFFICER", "CHIEFOPERATINGOFFICER", "CORPORATEOFFICER", "EXECUTIVEDIRECTOR", "DIRECTOR", "CHAIRMAN", "EXECUTIVEADMINISTRATOR", "RECEIVER", "PASTOR", "ASSISTANTTORELIGIOUSLEADER", "REVEREND", "PRIEST", "MINISTER", "RABBI", "LEADEROFRELIGIOUSORGANIZATION", "SECRETARY", "DIRECTOROFTAXATION", "DIRECTOROFPERSONNEL", "ADMINISTRATOR", "EXECUTOR", "TRUSTEE", "FIDUCIARY", "OWNER", "SOLEPROPRIETOR", "MEMBER", "SOLEMEMBER"
        KindOfEmployerstringOptional Identifies the kind of employer. Mandatory for W-2 and optional for W-2G and 94X series
Allowed values: "FEDERALGOVT", "STATEORLOCAL501C", "NONGOVT501C", "STATEORLOCALNON501C", "NONEAPPLY"
        KindOfPayerstringOptional Identifies the kind of payer. This field is mandatory in W-2 and optional in W-2G and 94X series
Allowed values: "REGULAR941", "REGULAR944", "AGRICULTURAL943", "HOUSEHOLD", "MILITARY", "MEDICAREQUALGOVEM", "RAILROADFORMCT1"
        IsBusinessTerminatedBooleanWhen true, identifies the business as terminated.
        IsForeignBooleanWhen true, identifies the business address with a foreign address.
        USAddressobjectIf IsForeign is false, pass US address of the business
            Address1stringEmployer/Payer's US address (street or post office box of that locality)
Size Range: ..35
            Address2stringOptional Employer/Payer's suite or apartment
Size Range: ..35
            CitystringEmployer/Payer's city
Size Range: ..27
            StatestringEmployer/Payer's state code. Refer Static values.
Size Range: 2
Allowed values: "AL", "AK", "AZ", "AR", "CA", "CO", "CT", "DE", "DC", "FL", "GA", "HI", "ID", "IL", "IN", "IA", "KS", "KY", "LA", "ME", "MD", "MA", "MI", "MN", "MS", "MO", "MT", "NE", "NV", "NH", "NJ", "NM", "NY", "NC", "ND", "OH", "OK", "OR", "PA", "RI", "SC", "SD", "TN", "TX", "UT", "VT", "VA", "WA", "WV", "WI", "WY", "AS", "FM", "GU", "MH", "MP", "PW", "PR", "VI", "AA", "AE", "AP"
            ZipCdstringEmployer/Payer's zip code
Size Range: 9
        ForeignAddressobjectIf IsForeign is true, pass foreign address of the business
            Address1stringEmployer/Payer's foreign address (street address or post office box of that locality)
Size Range: ..35
            Address2stringOptional Employer/Payer's suite or apartment
Size Range: ..35
            CitystringEmployer/Payer's city
Size Range: ..27
            ProvinceOrStateNmstringEmployer/Payer's province or state name
Size Range: ..30
            CountrystringEmployer/Payer's country
Size Range: 2
Allowed values: "US", "CA", "MX", "AF", "AX", "XI", "AL", "AG", "AQ", "AN", "AO", "AV", "AY", "AC", "AR", "AM", "AA", "XA", "AT", "AS", "AU", "AJ", "XZ", "BF", "BA", "FQ", "BG", "BB", "BS", "BO", "BE", "BH", "BN", "BD", "BT", "BL", "BK", "BC", "BV", "BR", "IO", "VI", "BX", "BU", "UV", "BM", "BY", "CB", "CM", "XY", "CV", "CJ", "CT", "CD", "XC", "CI", "CH", "KT", "IP", "CK", "CO", "CN", "CF", "CG", "CW", "CR", "VP", "CS", "IV", "HR", "CU", "CY", "EZ", "DA", "DX", "DJ", "DO", "DR", "TT", "EC", "EG", "ES", "UK", "EK", "ER", "EN", "ET", "EU", "FK", "FO", "FM", "FJ", "FI", "FR", "FG", "FP", "FS", "GB", "GA", "GZ", "GG", "GM", "GH", "GI", "GO", "GR", "GL", "GJ", "GP", "GQ", "GT", "GK", "GV", "PU", "GY", "HA", "HM", "HO", "HK", "HQ", "HU", "IC", "IN", "ID", "IR", "IZ", "EI", "IS", "IT", "JM", "JN", "JA", "DQ", "JE", "JQ", "JO", "JU", "KZ", "KE", "KQ", "KR", "KN", "KS", "KU", "KG", "LA", "LG", "LE", "LT", "LI", "LY", "LS", "LH", "LU", "MC", "MK", "MA", "MI", "MY", "MV", "ML", "MT", "IM", "RM", "MB", "MR", "MP", "MF", "MQ", "MD", "MN", "MG", "MJ", "MH", "MO", "MZ", "XM", "WA", "NR", "BQ", "NP", "NL", "NT", "NC", "NZ", "NU", "NG", "NI", "NE", "NF", "XN", "CQ", "NO", "MU", "OC", "PK", "LQ", "PS", "PM", "PP", "PF", "PA", "PE", "RP", "PC", "PL", "PO", "RQ", "QA", "RE", "RO", "RS", "RW", "WS", "SM", "TP", "SA", "XS", "SG", "RI", "SE", "SL", "SN", "XR", "LO", "SI", "BP", "SO", "SF", "SX", "SP", "PG", "CE", "SH", "SC", "ST", "SB", "VC", "SU", "NS", "SV", "WZ", "SW", "SZ", "SY", "TW", "TI", "TZ", "TH", "TO", "TL", "TN", "TD", "XT", "TE", "TS", "TU", "TX", "TK", "TV", "UG", "UP", "AE", "UY", "UZ", "NH", "VT", "VE", "VM", "VQ", "WQ", "XW", "WF", "WE", "WI", "YM", "YI", "ZA", "ZI"
            PostalCdstringEmployer/Payer's postal code
Size Range: 9
ReturnDataobject[]Contains information about the recipient details and Form W-2G details.
    SequenceIdstringAn 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.
Size Range: 50
    RecordIdGuidUnique identifier of a record. Not required when you are creating a return.
    RecipientobjectObject to identify the recipient details.
        RecipientIdGuidAn unique ID generated by TaxBandits after the return is created and will be returned in the Response. You can use this id for your future reference to Update.
        TINTypestringSpecify the TIN type of the recipient.
Allowed values: "SSN", "EIN", "ITIN", "ATIN", "NA"
        TINstringBring in the nine-digit taxpayer identification number of the Recipient (SSN, ITIN, ATIN, or EIN).
Size Range: 9
        FirstPayeeNmstringBring in the name of the recipient (preferably last name first for an Individual). If more space is required for the name, use the Second Payee Name Field.
Size Range: 40
        SecondPayeeNmstringOptional If there are multiple recipients (for example, partners, joint owners, or spouses), use this field for those names not associated with the TIN or if not enough space was provided in the First Payee Name, continue the name in this field.
Size Range: 40
        IsForeignBooleanWhen true, identifies the recipient address with a foreign address.
        USAddressobjectIf IsForeign is false, pass US address of the recipient
            Address1stringRecipient's US address (street address or post office box of that locality)
Size Range: ..35
            Address2stringOptional Recipient's suite or apartment
Size Range: ..35
            CitystringRecipient's city
Size Range: ..27
            StatestringRecipient's state code. Refer Static values.
Size Range: 2
Allowed values: "AL", "AK", "AZ", "AR", "CA", "CO", "CT", "DE", "DC", "FL", "GA", "HI", "ID", "IL", "IN", "IA", "KS", "KY", "LA", "ME", "MD", "MA", "MI", "MN", "MS", "MO", "MT", "NE", "NV", "NH", "NJ", "NM", "NY", "NC", "ND", "OH", "OK", "OR", "PA", "RI", "SC", "SD", "TN", "TX", "UT", "VT", "VA", "WA", "WV", "WI", "WY", "AS", "FM", "GU", "MH", "MP", "PW", "PR", "VI", "AA", "AE", "AP"
            ZipCdstringRecipient's zip code
Size Range: 9
        ForeignAddressobjectIf IsForeign is true, pass foreign address of the recipient
            Address1stringRecipient's foreign address (street address or post office box of that locality)
Size Range: ..35
            Address2stringOptional Recipient's suite or apartment
Size Range: ..35
            CitystringRecipient's city.
Size Range: ..27
            ProvinceOrStateNmstringRecipient's Province or State Name.
Size Range: ..30
            CountrystringRecipient's country code. Refer Static values.
Size Range: 2
Allowed values: "US", "CA", "MX", "AF", "AX", "XI", "AL", "AG", "AQ", "AN", "AO", "AV", "AY", "AC", "AR", "AM", "AA", "XA", "AT", "AS", "AU", "AJ", "XZ", "BF", "BA", "FQ", "BG", "BB", "BS", "BO", "BE", "BH", "BN", "BD", "BT", "BL", "BK", "BC", "BV", "BR", "IO", "VI", "BX", "BU", "UV", "BM", "BY", "CB", "CM", "XY", "CV", "CJ", "CT", "CD", "XC", "CI", "CH", "KT", "IP", "CK", "CO", "CN", "CF", "CG", "CW", "CR", "VP", "CS", "IV", "HR", "CU", "CY", "EZ", "DA", "DX", "DJ", "DO", "DR", "TT", "EC", "EG", "ES", "UK", "EK", "ER", "EN", "ET", "EU", "FK", "FO", "FM", "FJ", "FI", "FR", "FG", "FP", "FS", "GB", "GA", "GZ", "GG", "GM", "GH", "GI", "GO", "GR", "GL", "GJ", "GP", "GQ", "GT", "GK", "GV", "PU", "GY", "HA", "HM", "HO", "HK", "HQ", "HU", "IC", "IN", "ID", "IR", "IZ", "EI", "IS", "IT", "JM", "JN", "JA", "DQ", "JE", "JQ", "JO", "JU", "KZ", "KE", "KQ", "KR", "KN", "KS", "KU", "KG", "LA", "LG", "LE", "LT", "LI", "LY", "LS", "LH", "LU", "MC", "MK", "MA", "MI", "MY", "MV", "ML", "MT", "IM", "RM", "MB", "MR", "MP", "MF", "MQ", "MD", "MN", "MG", "MJ", "MH", "MO", "MZ", "XM", "WA", "NR", "BQ", "NP", "NL", "NT", "NC", "NZ", "NU", "NG", "NI", "NE", "NF", "XN", "CQ", "NO", "MU", "OC", "PK", "LQ", "PS", "PM", "PP", "PF", "PA", "PE", "RP", "PC", "PL", "PO", "RQ", "QA", "RE", "RO", "RS", "RW", "WS", "SM", "TP", "SA", "XS", "SG", "RI", "SE", "SL", "SN", "XR", "LO", "SI", "BP", "SO", "SF", "SX", "SP", "PG", "CE", "SH", "SC", "ST", "SB", "VC", "SU", "NS", "SV", "WZ", "SW", "SZ", "SY", "TW", "TI", "TZ", "TH", "TO", "TL", "TN", "TD", "XT", "TE", "TS", "TU", "TX", "TK", "TV", "UG", "UP", "AE", "UY", "UZ", "NH", "VT", "VE", "VM", "VQ", "WQ", "XW", "WF", "WE", "WI", "YM", "YI", "ZA", "ZI"
            PostalCdstringRecipient's Postal Code
Size Range: 9
        EmailstringRecipient's email address.
Size Range: 0..40
        FaxstringOptional Recipient's Fax number.
Size Range: 10
        PhonestringRecipient's Phone Number.
Size Range: 15
    W2GFormDataobjectRecipient's Form W-2G information
        B1ReportableWinningsnumberEnter the Reportable winning amount.
Size Range: 0-9999999999.99
        B2DateWonnumberEnter the date of the winning event.
Size Range: 8
        B3WagerTypeEnumEnter the type of wager
Size Range: 1
Allowed values: "HORSE_RACETRACK", "DOG_RACETRACK", "JAI_ALAI", "STATE_CONDUCTED_LOTTERY", "KENO", "BINGO", "SLOT_MACHINES", "POKER_WINNINGS", "ANY_OTHER_TYPE_OF_GAMBLING_WINNINGS"
        B4FedTaxWHnumberEnter any federal income tax withheld, whether regular gambling withholding or backup withholding.
Size Range: 0-9999999999.99
        B5TxnstringEnter the ticket or card number (and color, if applicable), machine serial number, other identifying number or any other information that will help identify the winning transaction.
Size Range: 15
        B6RacestringEnter the race (or game) relating to the winning ticket
Size Range: 5
        B7WinningsIdWagersnumberEnter the amount of additional winnings from identical wagers.
Size Range: 0-9999999999.99
        B8CashierstringEnter the initials or number of the cashier making the winning payment
Size Range: 5
        B10WindowstringEnter the window number or location of the person paying the winning payment.
Size Range: 5
        B11FirstIdstringEnter the first identification number of the person receiving the winning payment.
Size Range: 15
        B12SecondIdstringEnter the second identification number of the person receiving the winnings
Size Range: 15
        Statesobject[]Contains list of state returns information.
            StateCdstringState Code.
Size Range: 2
Allowed values: "AL", "AK", "AZ", "AR", "CA", "CO", "CT", "DE", "DC", "FL", "GA", "HI", "ID", "IL", "IN", "IA", "KS", "KY", "LA", "ME", "MD", "MA", "MI", "MN", "MS", "MO", "MT", "NE", "NV", "NH", "NJ", "NM", "NY", "NC", "ND", "OH", "OK", "OR", "PA", "RI", "SC", "SD", "TN", "TX", "UT", "VT", "VA", "WA", "WV", "WI", "WY", "AS", "FM", "GU", "MH", "MP", "PW", "PR", "VI", "AA", "AE", "AP"
            StateIdNumstringIdentification Number of State.
Size Range: ..20
            StateWinningsnumberEnter the Reportable state winning amount.
Size Range: 0-9999999999.99
            StateWHnumberIncome tax amount withheld for State.
Size Range: 0-9999999999.99
            LocalWinningsnumberEnter the Reportable Local winning amount.
Size Range: 0-9999999999.99
            LocalWHnumberLocal income tax withheld.
Size Range: 0-9999999999.99
            LocalityNmnumberName of the Locality.
Size Range: 0-9999999999.99
Errorsobject[]Shows detailed error information
    IdstringReturns the validation error Id
    NamestringName of the validation error
    MessagestringDescription of the validation error

Request JSON

FormW2G/Get?SubmissionId=05c4cfa0-aac5-491c-b5c3-95630933d3e7&RecordIds=1ece3ab0-381e-401d-81eb-93f500f9b493

Response JSON

{   "StatusCode": 200,   "StatusName": "Ok",   "StatusMessage": "Successful API call",   "FormW2GRecords": {       "SubmissionManifest": {           "SubmissionId": "05c4cfa0-aac5-491c-b5c3-95630933d3e7",           "TaxYear": "2021",           "IsFederalFiling": true,           "IsStateFiling": null,           "IsPostal": true,           "IsOnlineAccess": true,           "IsScheduleFiling": true,           "ScheduleFiling": {               "EfileDate": "12/24/2022"           }       },       "ReturnHeader": {           "Business": {               "BusinessId": "7f90187a-0586-4882-92d6-95014a964003",               "PayerRef": "8965",               "BusinessNm": "Nidok Kodak Com",               "TradeNm": "Origano",               "IsEIN": true,               "EINorSSN": "51-2822245",               "Email": "johnkin@speedo.com",               "ContactNm": "John Kaiser",               "Phone": "(123) 456-7890",               "PhoneExtn": "12345",               "Fax": "(123) 456-7890",               "BusinessType": "ESTE",               "SigningAuthority": {                   "Name": "John",                   "Phone": "(123) 456-7890",                   "BusinessMemberType": "ADMINISTRATOR"               },               "KindOfEmployer": "FEDERALGOVT",               "KindOfPayer": "REGULAR941",               "IsBusinessTerminated": false,               "IsForeign": false,               "USAddress": {                   "Address1": "1751 Kinsey Rd",                   "Address2": "Main St",                   "City": "Dothan",                   "State": "AL",                   "ZipCd": "36303"               },               "ForeignAddress": null,               "IsGovernmentalUnit": false           }       },       "ReturnData": [           {               "RecordId": "1ece3ab0-381e-401d-81eb-93f500f9b493",               "SequenceId": "1",               "Recipient": {                   "RecipientId": "f8e1b653-dd6a-4400-899f-7be88100e25f",                   "TINType": "EIN",                   "TIN": "39-3817572",                   "FirstPayeeNm": "Mark",                   "SecondPayeeNm": "Davis",                   "IsForeign": false,                   "USAddress": {                       "Address1": "1751 Kinsey Rd",                       "Address2": "Main St",                       "City": "Dothan",                       "State": "AL",                       "ZipCd": "36303"                   },                   "ForeignAddress": null,                   "Email": "john@gmail.com",                   "Fax": "(123) 456-7890",                   "Phone": "(123) 456-7890"               },               "W2GFormData": {                   "B1ReportableWinnings": 5000.65,                   "B2DateWon": "02/01/2022",                   "B3WagerType": "DOG_RACETRACK",                   "B4FedTaxWH": 46.15,                   "B5Txn": null,                   "B6Race": "Horse",                   "B7WinningsIdWagers": 700.00,                   "B8Cashier": "45",                   "B10Window": "78",                   "B11FirstId": "GA93393935",                   "B12SecondId": "NR935IIT935",                   "States": {                       "StateCd": "CA",                       "StateIdNum": "999-9999-9",                       "StateWinnings": 1000.00,                       "StateWH": 100.00,                       "LocalWinnings": 300.23,                       "LocalWH": 100.45,                       "LocalityNm": "PRISTINE"                   },                   "Business": null               }           }       ]   },   "Errors": null}