Version: 1.7.1

GetbyRecordIds

This endpoint can be used to get the information from the W-2G Form created against the particular record. You will be able to pull the data from multiple records created under different submissions.

The response will include the Business information, Recipient details, and W-2G Form data.

POST FormW2G/GetbyRecordIds

Request Body

Field	Type	Description
RecordIds	object[]	Contains the object of RecordId
RecordId	Guid	The unique identifier of the record. Provide the RecordId for which you need to obtain the information

Request Json

{
    "RecordIds": [
        {
            "RecordId": "6dbc5de2-1a19-4143-9a2e-1709a5610342"
        }
    ]
}

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
FormW2GRecords	object[]	Contains information about Form W2-G returns.
SubmissionManifest	object	SubmissionManifest 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.
SubmissionId	Guid	Unique identifier created by TaxBandits for each submission. Not required when you are creating a return.
TaxYear	string	Tax year of Form W-2G to be filed. Allowed values: "2022","2023","2024"
IsFederalFiling	Boolean	Federal Filing for the return will be enabled when the value is True. Form W-2G will be sent directly to the IRS.
IsStateFiling	Boolean	State 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.
IsPostal	Boolean	Postal 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.
IsOnlineAccess	Boolean	Online 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.
IsScheduleFiling	Boolean	When true, schedule filing services will be provided for Form W-2G returns under this submission.
ScheduleFiling	object	Contains preferred date to submit the returns to the IRS. Required only when "IsScheduleFiling" is True.
EfileDate	string	Date of Schedule Filing. Enter the date in the format: MM/DD/YYYY or MM-DD-YYYY Example: 10/20/2021 or 10-20-2021
ReturnHeader	object	Contains information about the Business details.
Business	object	Object to identify the Business Details.
BusinessId	Guid	Optional 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.
BusinessNm	string	Name of the business Size Range: ..80
FirstNm	string	First Name of the Individual Size Range: ..20
MiddleNm	string	Middle Name of the Individual Size Range: ..20
LastNm	string	Last Name of the Individual Size Range: ..20
Suffix	string	Suffix of the Individual Allowed values "Jr", "Sr", "I", "II", "III", "IV", "V", "VI", "VII"
TradeNm	string	Optional Name under which the business operates Size Range: ..80
IsEIN	Boolean	When true, identify that the business TIN is an EIN.
EINorSSN	string	When IsEIN is true, use Employer Identification Number (EIN). When IsEIN is false, use Social Security Number (SSN) Size Range: 9-11
Email	string	Optional Email address of the Business Size Range: ..100
ContactNm	string	Optional Name of the person who can be contacted by the IRS. Size Range: ..27
Phone	string	Optional Phone number of the business Size Range: 10
PhoneExtn	string	Optional Extension of the business phone number Size Range: ..5
Fax	string	Optional Fax number of the Business Size Range: 10
BusinessType	string	Optional Type of business. Optional for W-2/1099 and mandatory for 94X series Size Range: 4 Allowed values "ESTE", "PART", "CORP", "EORG", "SPRO"
SigningAuthority	object	Optional Details of the person who is authorized to sign the return
Name	string	Optional Name of the signing authority Size Range: ..35
Phone	string	Optional Phone number of the signing authority Size Range: 10
BusinessMemberType	string	Optional 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"
KindOfEmployer	string	Optional Identifies the kind of employer. Mandatory for W-2 and optional for W-2G and 94X series Allowed values "FEDERALGOVT", "STATEORLOCAL501C", "NONGOVT501C", "STATEORLOCALNON501C", "NONEAPPLY"
KindOfPayer	string	Optional 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"
IsBusinessTerminated	Boolean	When true, identifies the business as terminated.
IsForeign	Boolean	When true, identifies the business address with a foreign address.
USAddress	object	If IsForeign is false, pass US address of the business
Address1	string	Employer/Payer's US address (street or post office box of that locality) Size Range: ..46
Address2	string	Optional Employer/Payer's suite or apartment Size Range: ..46
City	string	Employer/Payer's city Size Range: ..50
State	string	Employer/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"
ZipCd	string	Employer/Payer's zip code. Size Range: 5..10
ForeignAddress	object	If IsForeign is true, pass foreign address of the business
Address1	string	Employer/Payer's foreign address (street address or post office box of that locality) Size Range: ..50
Address2	string	Optional Employer/Payer's suite or apartment Size Range: ..50
City	string	Employer/Payer's city Size Range: ..50
ProvinceOrStateNm	string	Employer/Payer's province or state name Size Range: ..50
Country	string	Employer/Payer's country Size Range: 2 Allowed values "AF", "AX", "AL", "AG", "AQ", "AN", "AO", "AV", "AY", "AC", "AR", "AM", "AA", "AT", "AS", "AU", "AJ", "BF", "BA", "FQ", "BG", "BB", "BO", "BE", "BH", "BN", "BD", "BT", "BL", "BK", "BC", "BV", "BR", "IO", "VI", "BX", "BU", "UV", "BM", "BY", "CB", "CM", "CA", "CV", "CJ", "CT", "CD", "CI", "CH", "KT", "IP", "CK", "CO", "CN", "CF", "CG", "CW", "CR", "CS", "IV", "HR", "CU", "UC", "CY", "EZ", "DA", "DX", "DJ", "DO", "DR", "TT", "EC", "EG", "ES", "EK", "ER", "EN", "ET", "FK", "FO", "FM", "FJ", "FI", "FR", "FP", "FS", "GB", "GA", "GG", "GM", "GH", "GI", "GR", "GL", "GJ", "GQ", "GT", "GK", "GV", "PU", "GY", "HA", "HM", "VT", "HO", "HK", "HQ", "HU", "IC", "IN", "ID", "IR", "IZ", "EI", "IS", "IT", "JM", "JN", "JA", "DQ", "JE", "JQ", "JO", "KZ", "KE", "KQ", "KR", "KN", "KS", "KV", "KU", "KG", "LA", "LG", "LE", "LT", "LI", "LY", "LS", "LH", "LU", "MC", "MK", "MA", "MI", "MY", "MV", "ML", "MT", "IM", "RM", "MR", "MP", "MX", "MQ", "MD", "MN", "MG", "MJ", "MH", "MO", "MZ", "WA", "NR", "BQ", "NP", "NL", "NC", "NZ", "NU", "NG", "NI", "NE", "NF", "CQ", "NO", "MU", "OC", "PK", "PS", "LQ", "PM", "PP", "PF", "PA", "PE", "RP", "PC", "PL", "PO", "RQ", "QA", "RO", "RS", "RW", "TB", "RN", "WS", "SM", "TP", "SA", "SG", "RI", "SE", "SL", "SN", "NN", "LO", "SI", "BP", "SO", "SF", "SX", "OD", "SP", "PG", "CE", "SH", "SC", "ST", "SB", "VC", "SU", "NS", "SV", "WZ", "SW", "SZ", "SY", "TW", "TI", "TZ", "TH", "TO", "TL", "TN", "TD", "TS", "TU", "TX", "TK", "TV", "UG", "UP", "AE", "UK", "UY", "UZ", "NH", "VE", "VM", "VQ", "WQ", "WF", "WI", "YM", "ZA", "ZI"
PostalCd	string	Employer/Payer's postal code Size Range: ..16
ReturnData	object[]	Contains information about the recipient details and Form W-2G details.
SequenceId	string	An 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
RecordId	Guid	Unique identifier of a record. Not required when you are creating a return.
Recipient	object	Object to identify the recipient details.
RecipientId	Guid	An 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.
TINType	string	Specify the TIN type of the recipient. Allowed values "SSN", "EIN", "ITIN", "ATIN", "NA"
TIN	string	Bring in the nine-digit taxpayer identification number of the Recipient (SSN, ITIN, ATIN, or EIN). Size Range: 9
FirstPayeeNm	string	Bring 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
SecondPayeeNm	string	Optional 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
FirstNm	string	First Name of the Individual Size Range: ..20
MiddleNm	string	Middle Name of the Individual Size Range: ..20
LastNm	string	Last Name of the Individual Size Range: ..20
Suffix	string	Suffix of the Individual Allowed values "Jr", "Sr", "I", "II", "III", "IV", "V", "VI", "VII"
USAddress	object	If IsForeign is false, pass US address of the recipient
Address1	string	Recipient's US address (street address or post office box of that locality) Size Range: ..46
Address2	string	Optional Recipient's suite or apartment Size Range: ..46
City	string	Recipient's city Size Range: ..50
State	string	Recipient'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"
ZipCd	string	Recipient's zip code Size Range: 5..10
ForeignAddress	object	If IsForeign is true, pass foreign address of the recipient
Address1	string	Recipient's foreign address (street address or post office box of that locality) Size Range: ..50
Address2	string	Optional Recipient's suite or apartment Size Range: ..50
City	string	Recipient's city. Size Range: ..50
ProvinceOrStateNm	string	Recipient's Province or State Name. Size Range: ..50
Country	string	Recipient's country code. Refer Static values. Size Range: 2 Allowed values "AF", "AX", "AL", "AG", "AQ", "AN", "AO", "AV", "AY", "AC", "AR", "AM", "AA", "AT", "AS", "AU", "AJ", "BF", "BA", "FQ", "BG", "BB", "BO", "BE", "BH", "BN", "BD", "BT", "BL", "BK", "BC", "BV", "BR", "IO", "VI", "BX", "BU", "UV", "BM", "BY", "CB", "CM", "CA", "CV", "CJ", "CT", "CD", "CI", "CH", "KT", "IP", "CK", "CO", "CN", "CF", "CG", "CW", "CR", "CS", "IV", "HR", "CU", "UC", "CY", "EZ", "DA", "DX", "DJ", "DO", "DR", "TT", "EC", "EG", "ES", "EK", "ER", "EN", "ET", "FK", "FO", "FM", "FJ", "FI", "FR", "FP", "FS", "GB", "GA", "GG", "GM", "GH", "GI", "GR", "GL", "GJ", "GQ", "GT", "GK", "GV", "PU", "GY", "HA", "HM", "VT", "HO", "HK", "HQ", "HU", "IC", "IN", "ID", "IR", "IZ", "EI", "IS", "IT", "JM", "JN", "JA", "DQ", "JE", "JQ", "JO", "KZ", "KE", "KQ", "KR", "KN", "KS", "KV", "KU", "KG", "LA", "LG", "LE", "LT", "LI", "LY", "LS", "LH", "LU", "MC", "MK", "MA", "MI", "MY", "MV", "ML", "MT", "IM", "RM", "MR", "MP", "MX", "MQ", "MD", "MN", "MG", "MJ", "MH", "MO", "MZ", "WA", "NR", "BQ", "NP", "NL", "NC", "NZ", "NU", "NG", "NI", "NE", "NF", "CQ", "NO", "MU", "OC", "PK", "PS", "LQ", "PM", "PP", "PF", "PA", "PE", "RP", "PC", "PL", "PO", "RQ", "QA", "RO", "RS", "RW", "TB", "RN", "WS", "SM", "TP", "SA", "SG", "RI", "SE", "SL", "SN", "NN", "LO", "SI", "BP", "SO", "SF", "SX", "OD", "SP", "PG", "CE", "SH", "SC", "ST", "SB", "VC", "SU", "NS", "SV", "WZ", "SW", "SZ", "SY", "TW", "TI", "TZ", "TH", "TO", "TL", "TN", "TD", "TS", "TU", "TX", "TK", "TV", "UG", "UP", "AE", "UK", "UY", "UZ", "NH", "VE", "VM", "VQ", "WQ", "WF", "WI", "YM", "ZA", "ZI"
PostalCd	string	Recipient's Postal Code Size Range: ..16
Email	string	Optional Recipient's email address. Size Range: 0..100
Fax	string	Optional Recipient's Fax number. Size Range: 10
Phone	string	Optional Recipient's Phone Number. Size Range: 15
W2GFormData	object	Recipient's Form W-2G information
B1ReportableWinnings	number	Enter the Reportable winning amount. Size Range: 0-9999999999.99
B2DateWon	number	Enter the date of the winning event. Size Range: 8
B3WagerType	Enum	Enter 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"
B4FedTaxWH	number	Enter any federal income tax withheld, whether regular gambling withholding or backup withholding. Size Range: 0-9999999999.99
B5Txn	string	Enter 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
B6Race	string	Enter the race (or game) relating to the winning ticket Size Range: 5
B7WinningsIdWagers	number	Enter the amount of additional winnings from identical wagers. Size Range: 0-9999999999.99
B8Cashier	string	Enter the initials or number of the cashier making the winning payment Size Range: 5
B10Window	string	Enter the window number or location of the person paying the winning payment. Size Range: 5
B11FirstId	string	Enter the first identification number of the person receiving the winning payment. Size Range: 15
B12SecondId	string	Enter the second identification number of the person receiving the winnings Size Range: 15
States	object[]	Contains list of state returns information.
StateCd	string	State 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"
StateIdNum	string	Identification Number of State. Size Range: ..20
StateWinnings	number	Enter the Reportable state winning amount. Size Range: 0-9999999999.99
StateWH	number	Income tax amount withheld for State. Size Range: 0-9999999999.99
LocalWinnings	number	Enter the Reportable Local winning amount. Size Range: 0-9999999999.99
LocalWH	number	Local income tax withheld. Size Range: 0-9999999999.99
LocalityNm	number	Name of the Locality. Size Range: 0-9999999999.99
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

Response JSON

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

{
    "StatusCode": 200,
    "StatusName": "Ok",
    "StatusMessage": "Successful API call",
    "FormW2GRecords": [
        {
            "SubmissionManifest": {
                "SubmissionId": "1abc3bc8-a3dc-499e-9e28-f25c0c458f32",
                "TaxYear": "2024",
                "IsFederalFiling": true,
                "IsStateFiling": true,
                "IsPostal": true,
                "IsOnlineAccess": true,
                "IsScheduleFiling": false,
                "ScheduleFiling": null
            },
            "ReturnHeader": {
                "Business": {
                    "BusinessId": "b161f84d-d38e-4d37-a2a4-ec952f8462cb",
                    "PayerRef": "Pe1234",
                    "BusinessNm": "Snowdaze LLC",
                    "FirstNm": null,
                    "MiddleNm": null,
                    "LastNm": null,
                    "Suffix": null,
                    "TradeNm": "Iceberg Icecreams",
                    "IsEIN": true,
                    "EINorSSN": "62-6369245",
                    "Email": "chandler@sample.com",
                    "ContactNm": "Chandler White",
                    "Phone": "(123) 456-7890",
                    "PhoneExtn": "12345",
                    "Fax": "(123) 456-7890",
                    "BusinessType": "ESTE",
                    "SigningAuthority": {
                        "Name": "Chandler White",
                        "Phone": "(123) 456-7890",
                        "BusinessMemberType": "ADMINISTRATOR"
                    },
                    "KindOfEmployer": "FEDERALGOVT",
                    "KindOfPayer": "REGULAR941",
                    "IsBusinessTerminated": true,
                    "IsForeign": false,
                    "USAddress": {
                        "Address1": "1751 Kinsey Rd",
                        "Address2": "Main St",
                        "City": "Dothan",
                        "State": "AL",
                        "ZipCd": "36303"
                    },
                    "ForeignAddress": null,
                    "ACADetails": null
                }
            },
            "ReturnData": [
                {
                    "RecordId": "6dbc5de2-1a19-4143-9a2e-1709a5610342",
                    "SequenceId": "1",
                    "IsPostal": true,
                    "IsOnlineAccess": true,
                    "Recipient": {
                        "RecipientId": "ff406310-e6bd-4538-b1cc-0354bb5c1756",
                        "TINType": "EIN",
                        "TIN": "39-3817572",
                        "FirstPayeeNm": "Stephen",
                        "SecondPayeeNm": null,
                        "FirstNm": null,
                        "LastNm": null,
                        "MiddleNm": null,
                        "Suffix": null,
                        "IsForeign": false,
                        "USAddress": {
                            "Address1": "1751 Kinsey Rd",
                            "Address2": "Main St",
                            "City": "Dothan",
                            "State": "AL",
                            "ZipCd": "36303"
                        },
                        "ForeignAddress": null,
                        "Email": "mark+32@sample.com",
                        "Fax": "(123) 456-7890",
                        "Phone": "(123) 456-7890"
                    },
                    "W2GFormData": {
                        "B1ReportableWinnings": 50000.65,
                        "B2DateWon": "02/01/2023",
                        "B3WagerType": "DOG_RACETRACK",
                        "B4FedTaxWH": 500.82,
                        "B5Txn": null,
                        "B6Race": "Horse",
                        "B7WinningsIdWagers": 700.89,
                        "B8Cashier": "Yugyu",
                        "B10Window": "78.35",
                        "B11FirstId": "GA93393935",
                        "B12SecondId": "NR935IIT935",
                        "States": {
                            "StateCd": "CA",
                            "StateIdNum": "999-9999-9",
                            "StateWinnings": 1000.56,
                            "StateWH": 100.28,
                            "LocalWinnings": 300.23,
                            "LocalWH": 100.45,
                            "LocalityNm": "PRISTINE"
                        }
                    }
                }
            ]
        }
    ],
    "Errors": null
}

W-9 Automation

BOIR Automation

TIN Matching

1099 Automation

941/940 Automation

W-2 Automation

ACA Automation

Supported Forms

Gig Software

Payroll Software

Affiliate Software

HOA Software

Reselling Platform

HCM Providers

Property Management

Supported Forms

Request Body

Request Json

Response Body

Response JSON