Version: 1.7.3

Update

Updates the existing Form W2G return created in TaxBandits. Use the unique identifiers to refer a particular return. You cannot update a Transmitted return.

PUT FormW2G/Update

Request Body

Field	Type	Description
SubmissionManifest	object	SubmissionManifest provides brief information about a particular submission on the whole. It contains information like Submission ID Tax Year IsPostal IsFederalFiling 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 W2G to be filed.. Allowed values: "2022","2023","2024"
IsFederalFiling	Boolean	Federal Filing for the return will be enabled when the value is True. Form W2-G will be sent directly to the IRS.
IsStateFiling	Boolean	State Filing for the return will be enabled when the value is True. Form W2-G 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	If this value is set as true, the Postal Mailing service will be opted for all the recipients included in the submission. Once the returns are transmitted, the W-2G form copies will be mailed to the recipient's address via USPS. Note: Postal Orders for Foreign Address will not be created.
IsOnlineAccess	Boolean	If this value is set as true, the Online Access service will be enabled for all the recipients included in the submission. Once the returns are transmitted, an email with a link to the secure TaxBandits portal will be sent to the recipients. The recipients can then provide consent and download Form W-2G copies from the portal.
IsScheduleFiling	Boolean	When true, schedule filing services will be provided for Form W2-G 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: ..75
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"
PayerRef	string	Optional 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
TradeNm	string	Optional Name under which the business operates Size Range: ..75
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	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	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" For the description of the Allowed Values , click here
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	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	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.
IsPostal	Boolean	If this value is set as true, the Postal Mailing service will be opted for the recipient included in the record. Once the return is transmitted, the W-2G copy will be mailed to the recipient's address via USPS. Postal Orders for Foreign Address will not be created. Note: To enable this, you must have set the IsPostal value as True under the submission. You can set this value as False for the other records for which you don’t want this service.
IsOnlineAccess	Boolean	If this value is set as true, the Online Access service will be enabled for the recipient included in the record. Once the return is transmitted, an email with a link to the secure TaxBandits portal will be sent to the recipient. The recipient can then provide consent and download Form W-2G copy from the portal. Note: To enable this, you must have set the IsOnlineAccess value as True under the submission. You can set this value as False for the other records for which you don’t want this service.
RecordId	Guid	OptionalUnique Identifier of the Record. Mention the Form W2-G return's Record ID that you want to update. If you do not provide the Record ID, then a new record will be added to the submission.
Recipient	object	Object to identify the recipient details.
RecipientId	Guid	OptionalAn 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. Note: If the recipient doesn't have a TIN, enter the TIN type as 'NA' and input 'null' in the TIN field. 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-11
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"
IsForeign	Boolean	When true, identifies the recipient address with a foreign address.
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 Note : This email address cannot be the same for two different recipients under the same business.
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 Note : This value should be less than 40% of box 1.
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

Request JSON

Sample 1
Sample 2

Created a Form W2G return for the specific Business, including recipient and income information. Now, update the Recipient/Form Details with RecipientId and RecordId

{
    "SubmissionManifest": {
        "SubmissionId": "4094b7bc-9ba4-4bb2-8f6d-c32e7633abe4",
        "TaxYear": "2024",
        "IsFederalFiling": true,
        "IsStateFiling": true,
        "IsPostal": true,
        "IsOnlineAccess": true,
        "IsScheduleFiling": false,
        "ScheduleFiling": null
    },
    "ReturnHeader": {
        "Business": {
            "BusinessId": "b161f84d-d38e-4d37-a2a4-ec952f8462cb",
            "BusinessNm": "Snowdaze LLC",
            "FirstNm": null,
            "MiddleNm": null,
            "LastNm": null,
            "Suffix": null,
            "PayerRef": "Pe123",
            "TradeNm": "Iceberg Icecreams",
            "IsEIN": true,
            "EINorSSN": "62-7469245",
            "Email": "chandler@sample.com",
            "ContactNm": "Chandler White",
            "Phone": "1234567890",
            "PhoneExtn": "12345",
            "Fax": "1234567890",
            "BusinessType": "ESTE",
            "SigningAuthority": {
                "Name": "Chandler White",
                "Phone": "1234567890",
                "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": {
                "Address1": null,
                "Address2": null,
                "City": null,
                "ProvinceOrStateNm": null,
                "Country": null,
                "PostalCd": null
            }
        }
    },
    "ReturnData": [
        {
            "SequenceId": "1",
            "RecordId": "f179e126-20c1-4a62-b830-4928940a0ff0",
            "IsPostal": true,
            "IsOnlineAccess": true,
            "IsForced": true,
            "Recipient": {
                "RecipientId": "63ce1ce9-8eef-4342-9f4c-006542f8eb50",
                "TINType": "SSN",
                "TIN": "393817572",
                "FirstPayeeNm": null,
                "SecondPayeeNm": null,
                "FirstNm": "Mark",
                "MiddleNm": "Freek",
                "LastNm": "Linda",
                "Suffix": "Sr",
                "IsForeign": false,
                "USAddress": {
                    "Address1": "1751 Kinsey Rd",
                    "Address2": "Main St",
                    "City": "Dothan",
                    "State": "AL",
                    "ZipCd": "36303"
                },
                "ForeignAddress": {
                    "Address1": null,
                    "Address2": null,
                    "City": null,
                    "ProvinceOrStateNm": null,
                    "Country": null,
                    "PostalCd": null
                },
                "Email": "mark@sample.com",
                "Fax": "1234567890",
                "Phone": "1234567890"
            },
            "W2GFormData": {
                "B1ReportableWinnings": 50000.65,
                "B2DateWon": "02/01/2022",
                "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"
                }
            }
        }
    ]
}

Created a Form W2G return for the specific Business, including recipient and income information. Now, create a new Recipient/Form without RecipientId and RecordId.

{
    "SubmissionManifest": {
        "SubmissionId": "a36f4c1a-2765-4768-a1f7-577356bf3626",
        "TaxYear": "2024",
        "IsFederalFiling": true,
        "IsStateFiling": true,
        "IsPostal": true,
        "IsOnlineAccess": true,
        "IsScheduleFiling": false,
        "ScheduleFiling": null
    },
    "ReturnHeader": {
        "Business": {
            "BusinessId": "ba6b566f-a19a-40f0-99f2-6cba22325b9f",
            "BusinessNm": "Snowdaze LLC",
            "FirstNm": "Mark",
            "MiddleNm": "Freek",
            "LastNm": "Linda",
            "Suffix": "Sr",
            "PayerRef": "Pe123",
            "TradeNm": "Iceberg Icecreams",
            "IsEIN": true,
            "EINorSSN": "62-2269245",
            "Email": "chandler@sample.com",
            "ContactNm": "Chandler White",
            "Phone": "1234567890",
            "PhoneExtn": "12345",
            "Fax": "1234567890",
            "BusinessType": "ESTE",
            "SigningAuthority": {
                "Name": "Chandler White",
                "Phone": "1234567890",
                "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": {
                "Address1": null,
                "Address2": null,
                "City": null,
                "ProvinceOrStateNm": null,
                "Country": null,
                "PostalCd": null
            }
        }
    },
    "ReturnData": [
        {
            "RecordId": null,
            "SequenceId": "1",
            "IsPostal": true,
            "IsOnlineAccess": true,
            "IsForced": false,
            "Recipient": {
                "RecipientId": null,
                "TINType": "SSN",
                "TIN": "563887472",
                "FirstPayeeNm": null,
                "SecondPayeeNm": null,
                "FirstNm": "Mark",
                "MiddleNm": "Freek",
                "LastNm": "Linda",
                "Suffix": "Sr",
                "IsForeign": false,
                "USAddress": {
                    "Address1": "1751 Kinsey Rd",
                    "Address2": "Main St",
                    "City": "Dothan",
                    "State": "AL",
                    "ZipCd": "36303"
                },
                "ForeignAddress": {
                    "Address1": null,
                    "Address2": null,
                    "City": null,
                    "ProvinceOrStateNm": null,
                    "Country": null,
                    "PostalCd": null
                },
                "Email": null,
                "Fax": "1234567890",
                "Phone": "1234567890"
            },
            "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"
                }
            }
        }
    ]
}

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
SubmissionId	Guid	Unique identifier of a submission
BusinessId	Guid	Unique identifier of a Business.
PayerRef	string	Unique identifier of the payer.
Form1099Type	string	Denotes the type of 1099 form.
Form1099Records	object	Pulls Form W-2G records with Success and Error statuses
SuccessRecords	object[]	It will show the detailed information about the success status of Form W-2G Records
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.
RecordId	Guid	An unique identifier generated by TaxBandits when a W-2G return is created.
RecipientId	Guid	An unique identifier generated by TaxBandits for a Recipient when a W-2G return is created. You can use this id for your future reference to Update.
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.
Postal	object	Returns the status and StatusTs of postal mailing service for Form W-2G.
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 return.
Email	string	Email address for whom the online access to be given.
Info	string	Information about the online access service.
ScheduleFiling	object	Returns the date of the schedule filing.
ScheduledOn	string	Date of the schedule filing to know when the return to be filed to the IRS.
Info	string	Information about Schedule Filing service.
ErrorRecords	object[]	It will show the detailed information about the error status of Form W-2G Records.
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.
RecordId	Guid	Unique identifier of a record
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
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",
    "SubmissionId": "a8deed38-cc9f-4ae5-997a-4cd61e827ea7",
    "BusinessId": "b161f84d-d38e-4d37-a2a4-ec952f8462cb",
    "PayerRef": "Pe1234",
    "Form1099Type": "W2G",
    "FormW2GRecords": {
        "SuccessRecords": [
            {
                "SequenceId": "1",
                "RecordId": "af87d634-c045-4444-a59d-45e70c1ffbcd",
                "RecipientId": "ff406310-e6bd-4538-b1cc-0354bb5c1756",
                "FederalReturn": {
                    "Status": "CREATED",
                    "StatusTs": "2024-07-01 06:45:31 -04:00",
                    "Info": null,
                    "Errors": null
                },
                "StateReturns": {
                    "StateCd": "CA",
                    "Status": "NOTCREATED",
                    "StatusTs": null,
                    "Info": "Taxbandits Currently does not support StateFiling for the Form W2G",
                    "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": null
            }
        ],
        "ErrorRecords": null
    },
    "Errors": null
}

Multi-status Response - You'll get the below response when multiple statuses are included.

{
    "StatusCode": 300,
    "StatusName": "MultiStatus",
    "StatusMessage": "Multiple statuses are available for the request",
    "SubmissionId": "204231f2-ba14-410e-b057-3b6f101fc263",
    "BusinessId": "f87e6f65-b036-4cad-9c20-a03200d9a1c7",
    "PayerRef": "RN123",
    "Form1099Type": "W2G",
    "FormW2GRecords": {
        "SuccessRecords": [
            {
                "SequenceId": "3",
                "RecordId": "ce520d86-830c-4803-8f42-1d43f58077be",
                "RecipientId": "2332dc2f-a2c0-484e-8fc4-434ff753b5b8",
                "FederalReturn": {
                    "Status": "CREATED",
                    "StatusTs": "2024-07-01 06:54:29 -04:00",
                    "Info": null,
                    "Errors": null
                },
                "StateReturns": {
                    "StateCd": "CA",
                    "Status": "NOTCREATED",
                    "StatusTs": null,
                    "Info": "Taxbandits Currently does not support StateFiling for the Form W2G",
                    "Errors": null
                },
                "Postal": {
                    "Status": "CREATED",
                    "StatusTs": "2024-07-01 06:55:19 -04:00",
                    "Info": null
                },
                "OnlineAccess": {
                    "Status": "CREATED",
                    "Email": "mark+23@sample.com",
                    "Info": null
                },
                "ScheduleFiling": null
            }
        ],
        "ErrorRecords": [
            {
                "SequenceId": "4",
                "RecordId": null,
                "Errors": [
                    {
                        "Id": "RECPT-0008",
                        "Name": "Recipient.TIN[1]",
                        "Message": "TIN must have 9 digits."
                    }
                ]
            }
        ]
    },
    "Errors": [
        {
            "Id": "F00-100155",
            "Name": "Error Records",
            "Message": "Some of the records are errored. Please read the Error Records for more details."
        }
    ]
}

Bad Request Response - You'll get the below response when your API requests contain any validation errors.

{
    "StatusCode": 400,
    "StatusName": "BadRequest",
    "StatusMessage": "Validation error has occurred",
    "SubmissionId": null,
    "BusinessId": "b161f84d-d38e-4d37-a2a4-ec952f8462cb",
    "PayerRef": "Pe1234",
    "Form1099Type": "W2G",
    "FormW2GRecords": {
        "SuccessRecords": null,
        "ErrorRecords": [
            {
                "SequenceId": "1",
                "RecordId": null,
                "Errors": [
                    {
                        "Id": "RECPT-0013",
                        "Name": "Recipient.FirstPayeeNm[0]",
                        "Message": "First Payee Name is required."
                    }
                ]
            }
        ]
    },
    "Errors": null
}

W-9 Automation

BOI Automation New

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