TaxBandits API

# FormW2G

# Create

Creates Form W2G returns in TaxBandits. You can send multiple W2G forms in a single request for the same Payer. In response, a SubmissionId is created which is further used as a reference for all other methods of Form W2G API.

POST FormW2G/Create
1

Request Body

Field Type Description
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: "2021"
    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
        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: ..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
        Email string Email address of the Business
Size Range: ..40
        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"
        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: ..35
            Address2 string Optional Employer/Payer's suite or apartment
Size Range: ..35
            City string Employer/Payer's city
Size Range: ..27
            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: 9
        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: ..35
            Address2 string Optional Employer/Payer's suite or apartment
Size Range: ..35
            City string Employer/Payer's city
Size Range: ..27
            ProvinceOrStateNm string Employer/Payer's province or state name
Size Range: ..30
            Country string Employer/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"
            PostalCd string Employer/Payer's postal code
Size Range: 9
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
        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: ..35
            Address2 string Optional Recipient's suite or apartment
Size Range: ..35
            City string Recipient's city
Size Range: ..27
            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: 9
        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: ..35
            Address2 string Optional Recipient's suite or apartment
Size Range: ..35
            City string Recipient's city.
Size Range: ..27
            ProvinceOrStateNm string Recipient's Province or State Name.
Size Range: ..30
            Country string Recipient'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"
            PostalCd string Recipient's Postal Code
Size Range: 9
        Email string Recipient's email address.
Size Range: 0..40
        Fax string Optional Recipient's Fax number.
Size Range: 10
        Phone string 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

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.
FormW2GRecords 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

Request JSON

{
   "SubmissionManifest": {
       "SubmissionId": null,
       "TaxYear": "2021",
       "IsFederalFiling": true,
       "IsStateFiling": true,
       "IsPostal": true,
       "IsOnlineAccess": true,
       "IsScheduleFiling": true,
       "ScheduleFiling": {
           "EfileDate": "12/24/2022"
       }
   },
   "ReturnHeader": {
       "Business": {
           "BusinessId": null,
           "BusinessNm": "Nidok Kodak Com",
           "PayerRef": "8965",
           "TradeNm": "Origano",
           "IsEIN": true,
           "EINorSSN": "512822245",
           "Email": "johnkin@speedo.com",
           "ContactNm": "John Kaiser",
           "Phone": "1234567890",
           "PhoneExtn": "12345",
           "Fax": "1234567890",
           "BusinessType": "ESTE",
           "SigningAuthority": {
               "Name": "John",
               "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",
           "Recipient": {
               "RecipientId": null,
               "TINType": "SSN",
               "TIN": "292187572",
               "FirstPayeeNm": "Mark",
               "SecondPayeeNm": "Davis",
               "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": "johnkaiser@dema.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"
               }
           }
       }
   ]
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108

Response JSON

{
   "StatusCode": 200,
   "StatusName": "Ok",
   "StatusMessage": "Successful API call",
   "SubmissionId": "05c4cfa0-aac5-491c-b5c3-95630933d3e7",
   "BusinessId": "7f90187a-0586-4882-92d6-95014a964003",
   "PayerRef": "8965",
   "Form1099Type": "W2G",
   "FormW2GRecords": {
       "SuccessRecords": [
           {
               "SequenceId": "1",
               "RecordId": "1ece3ab0-381e-401d-81eb-93f500f9b493",
               "RecipientId": "5698c1b7-89e3-4635-91c0-e9db8c12a83b",
               "FederalReturn": {
                   "Status": "CREATED",
                   "StatusTs": "2022-05-06 07:28:51 -04:00",
                   "Info": null
               },
               "Postal": {
                   "Status": null,
                   "StatusTs": null,
                   "Info": "This Service will be available soon"
               },
               "OnlineAccess": {
                   "Status": null,
                   "Email": null,
                   "Info": "This Service will be available soon"
               },
               "ScheduleFiling": {
                   "ScheduledOn": null,
                   "Info": "This Service will be available soon"
               }
           }
       ],
       "ErrorRecords": null
   },
   "Errors": null
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39

# Delete

Deletes Form W2-G return created in TaxBandits. Transmitted forms cannot be deleted.

DELETE FormW2G/Delete
1

Request Body

Field Type Description
SubmissionId Guid Unique identifier of a submission
RecordIds guid[] An unique identifier generated by TaxBandits when a W2-G return is created. Mention the W2-G return's Record ID that you want to delete.

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
Form1099Records object Pulls the Form W2-G records with Success and Error statuses
    SuccessRecords object[] It will show the detailed information about the success status of Form W2-G Records
        SequenceId string A unique number is given by an inbound application to identify failed records
        RecordId Guid Unique identifier of a record
        Status string Returns the status of the records.
        StatusTs string Date and time of return deleted.
    ErrorRecords object[] It will show the detailed information about the error status of Form W2-G Records.
        SequenceId string A unique number given by an inbound application to identify failed records
        RecordId Guid Unique identifier of a record
        Errors object[] Shows detailed error information
            Id string Returns the validation error code
            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 code
    Name string Name of the validation error
    Message string Description of the validation error

Request JSON

FormW2G/Delete?SubmissionId=9d71ae45-df5f-49f7-86f8-e88f54132fa1&RecordIds=15c3caa6-8402-4548-8713-4fcdd2f7d42d
1

Response JSON

{
  "StatusCode": 200,
  "StatusName": "Ok",
  "StatusMessage": "Successful API call",
  "SubmissionId": "9d71ae45-df5f-49f7-86f8-e88f54132fa1",
  "Form1099Records": {
      "SuccessRecords": [
          {
              "SequenceId": "1",
              "RecordId": "15c3caa6-8402-4548-8713-4fcdd2f7d42d",
              "Status": "DELETED",
              "StatusTs": "2021-08-05 06:26:16 -04:00"
          },
          {
              "SequenceId": "2",
              "RecordId": "eb39714e-f653-4c4d-a53c-07f24f9a9dj5",
              "Status": "DELETED",
              "StatusTs": "2021-08-05 06:26:16 -04:00"
          }
      ],
      "ErrorRecords": null
  },
  "Errors": null
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24

# Get

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

GET FormW2G/Get
1

Request Body

Field Type Description
SubmissionId Guid A 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.
RecordIds Guid[] 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

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: "2021"
    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
        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: ..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
        Email string Email address of the Business
Size Range: ..40
        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"
        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: ..35
            Address2 string Optional Employer/Payer's suite or apartment
Size Range: ..35
            City string Employer/Payer's city
Size Range: ..27
            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: 9
        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: ..35
            Address2 string Optional Employer/Payer's suite or apartment
Size Range: ..35
            City string Employer/Payer's city
Size Range: ..27
            ProvinceOrStateNm string Employer/Payer's province or state name
Size Range: ..30
            Country string Employer/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"
            PostalCd string Employer/Payer's postal code
Size Range: 9
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
        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: ..35
            Address2 string Optional Recipient's suite or apartment
Size Range: ..35
            City string Recipient's city
Size Range: ..27
            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: 9
        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: ..35
            Address2 string Optional Recipient's suite or apartment
Size Range: ..35
            City string Recipient's city.
Size Range: ..27
            ProvinceOrStateNm string Recipient's Province or State Name.
Size Range: ..30
            Country string Recipient'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"
            PostalCd string Recipient's Postal Code
Size Range: 9
        Email string Recipient's email address.
Size Range: 0..40
        Fax string Optional Recipient's Fax number.
Size Range: 10
        Phone string 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

Request JSON

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

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
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102

# GetPDF

Retrieves Form W2G PDFs. The link for PDFs download will be sent via Webhook after successful API call.

GET FormW2G/GetPDF
1

Request Body

Field Type Description
SubmissionId Guid Unique identifier of a submission
RecordIds Guid[] Optional Unique identifier of a records.
TINMaskType string Optional Choose the masking type of your Recipient's TIN on the W2-G PDF. MASKED - The Recipient's TIN will be masked in the PDF. Only the last 4 digits of the TIN can beread.UNMASKED - The Recipient's TIN will not be masked in the PDF. To protect the PII information of the Recipient, thePDF with Unmasked TIN is password protected. Use the Recipient's TIN (password) to open the protected file.BOTH - TwoPDFs will be delivered for each Recipient.One with Masked TIN and the other with Unmasked TIN. The PDF with Unmasked TINwill be password protected.
Allowed values: "MASKED", "UNMASKED", "BOTH"

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
FormW2GRecords object[] Collection of Form W2-G records for which the PDF will be successfull delivered
    RecordId guid Unique identifier of a record
    Message string Provides additional information regarding the PDF delivery.
Errors object[] Shows detailed error information
    Id string Returns the validation error code
    Name string Name of the validation error
    Message string Description of the validation error
    Type string Type of validation error

Request JSON

FormW2G/GetPdf?SubmissionId=894b9d16-da83-424b-b0f7-41bfd37eb3a7&RecordIds=5c263d8c-fa58-4af4-af14-d109db5f49e7& TINMaskType=UNMASKED
1

Response JSON

{
   "StatusCode": 200,
   "StatusName": "Ok",
   "StatusMessage": "Successful API call",
   "SubmissionId": "894b9d16-da83-424b-b0f7-41bfd37eb3a7",
   "FormW2GRecords": [
       {
           "RecordId": "5c263d8c-fa58-4af4-af14-d109db5f49e7",
           "Message": "We've successfully received your request to generate PDF. You will be notified with the URL to download the PDF."
       }
   ],
   "Errors": null
}
1
2
3
4
5
6
7
8
9
10
11
12
13

# 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
1

Request Body

Field Type Description
SubmissionId Guid Unique identifier of a submission
BusinessId Guid Unique identifier of a business
TINType string List the W2 G records based on the given TINType and TIN.
TIN string List the W2 G records based on the given TIN.
TaxYear string List the W2 G records based on the given taxyear.
Page number Pulls the records listed in the page selected
PageSize number Number of W2 G records to be listed in each page.
EfileStatus string List the W2 G records based on the status ("CREATED, UNDERPROCESS, SENTTOAGENCY, TRANSMITTED, ACCEPTED, REJECTED")
FromDate string Enter a date from which the Form W2-G records need to be listed.
ToDate string Enter a date till which the W2-G records created are to be listed.

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
Form1099Type string Denotes the type of W2G form.
Form1099Records object[] Returns detailed information of the Form W2 G records.
    SubmissionId Guid Unique identifier of a submission
    BusinessId Guid Unique identifier of a business
    PayerRef string Unique identifier of the payer.
    BusinessNm string Name of the business
    IsEIN Boolean When true, identifies the business with an EIN.
    EINorSSN string When IsEIN is true, use Employer Identification Number (EIN). When IsEIN is false, use Social Security Number (SSN)
    ContactNm string Contact Name of the Business.
    TaxYear string Tax year of W2 G to be filed.
    Recipient object Details of the Recipient.
        SequenceId string A 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 A unique identifier generated by TaxBandits when a W2-G return is created.
        RecipientId Guid A 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.
        RecipientNm Boolean Name of Recipient.
        TINType string TIN type of the Recipient.
        TIN string TIN of the Recipient.
        Status string The status of Form W2 G.
Page number Pulls the records listed in the page selected
TotalRecords number Total number of records.
TotalPages number Total number of pages.
PageSize number Number of 1099 G records to be listed in each page.
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

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"
1

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
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32

# RequestDraftPdfUrl

This API request will return the Draft PDF of the forms that are not transmitted yet for review purpose. The draft PDF will have copy A of the form with For Review Only watermark text.

Note: You can only retrieve PDF of a single record/form using this method.

How does it works?

  1. Call the [POST] FormW2G/RequestDraftPdfUrl endpoint. You will need to supply the following parameters:

    • Access Token in the header as Bearer Token (Generated using TaxBandits OAuth authentication API)

    • Request Parameters: Specify the RecordId for the form you need the Draft PDF form. If you do not have the RecordId, then you request the PDF using the following parameters

      • Business Reference - Use the business reference PayerRef or BusinessId or TIN.
      • Recipient Reference - Use the recipient reference PayeeRef or RecipientId or TIN.
      • Tax Year - Tax year of the form you are requesting the PDF. 

POST FormW2G/RequestDraftPdfUrl
1

Request Body

Field Type Description
RecordId Guid Optional Specify the RecordId of the return
TINMaskType string Optional TIN Mask type on the TIN printed on the PDF
Allowed values: "MASKED", "UNMASKED"
TaxYear string Optional Tax Year of the return. Specify only if you do not have the RecordId
Business object Optional Collects the Business identifier TIN or TBS Business Id or PayerRef. This object information is required only if you do not have the RecordId
    BusinessId Guid Optional TaxBandits Unique Business Identifier. This ID is generated by TaxBandits after you create a business in your account using the Business endpoint.
    PayerRef string Optional Unique payer identifier assigned by the client.
Size Range: 1 to 50
    TINType string Optional TIN type of the Business TIN. Use this as an alternative for BusinessId or PayerRef.
Allowed values: "SSN,EIN"
    TIN string Optional Taxpayer Identification Number. Use this as an alternative for BusinessId or PayerRef.
Size Range: 9 to 11
Recipient object Optional Collects the recipient's unique identifier. This object information is required only if you do not have the RecordId
    PayeeRef string Optional An unique identifier for each recipient set by the client.
Size Range: 1 to 50
    RecipientId Guid Optional Unique Recipient Identifier generated by TaxBandits
    TINType string Optional TIN type of the Recipient’s TIN. Use this as an alternative for RecipientId or PayeeRef.
Allowed values: "SSN,EIN"
    TIN string Optional Taxpayer Identification Number. Use this as an alternative for RecipientId or PayeeRef.

Response Body

Field Type Description
RecordId Guid Unique identifier of the record
RecipientId Guid Unique Recipient Identifier generated by TaxBandits
PayeeRef string An unique identifier for each recipient set by the client.
DraftPdfUrl string URL of the Draft PDF
Errors object[] Shows detailed error information
    Id string Returns the validation error code
    Name string Name of the validation error
    Message string Description of the validation error

Request JSON 1: With just the RecordId

{
  "TaxYear": null,
  "RecordId": "15430b5d-056a-4989-8293-6ce2905874c5",
  "Business": null,
  "Recipient": null
}
1
2
3
4
5
6

Response JSON 1

{
   "RecordId": "15430b5d-056a-4989-8293-6ce2905874c5",
   "RecipientId": "48e386a9-7e24-4780-966e-dc5835d0f4b0",
   "PayeeRef": null,
   "DraftPdfUrl": "https://expressirsforms.s3.us-east-1.amazonaws.com/pdfs/7dbfa93b-1b4e-4870-a875-b3636d875522/1e9ed204-870f-4b61-acac-6c3ecf11abf6/w2g/898299/d/copy_draft_1up_7695918535.pdf",
   "Error": null
}
1
2
3
4
5
6
7

Request JSON 2: With No RecordId

{
 "TaxYear": "2021",
 "RecordId": null,
 "Business": {
   "BusinessId": "94B6214D-8DCA-490C-8FC3-602840B439B5",
   "PayerRef": null,
   "TINType": null,
   "TIN": null
 },
 "Recipient": {
   "RecipientId": "6DDFFB5A-565F-402D-8602-7ECD917CEC04",
   "PayeeRef": null,
   "TINType": null,
   "TIN": null
 }
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16

Response JSON 2

{
  "RecordId": "cf0a188b-6661-4b57-b04b-ba9ead52a16e",
  "RecipientId": "6DDFFB5A-565F-402D-8602-7ECD917CEC04",
  "PayeeRef": null,
  "DraftPdfUrl":"https://expressirsforms.s3.us-east-1.amazonaws.com/pdfs/7dbfa93b-1b4e-4870-a875-b3636d875522/1e9ed204-870f-4b61-acac-6c3ecf11abf6/w2g/898299/d/copy_draft_1up_7695918535.pdf",
  "Error": null
}
1
2
3
4
5
6
7

# RequestPdfURLs

This method can be used to retrieve PDFs for single or multiple recipients. The PDF URL will be returned in the response only if it is already generated by us. You can use the SubmissionId or RecordIds to request the pdf URLs.

Note: The PDF URL will be returned in response only after the return is transmitted in the API. This method will not work for Inprogress returns.

POST FormW2G/RequestPdfURLs
1

Request Body

Field Type Description
SubmissionId Guid Optional Unique identifier of an API submission. Use this node to request the PDFs under a particular submission. If you are going to request the PDFs using the RecordIds, you can leave the SubmissionId blank or null.
RecordIds object[] Contains the list of RecordIds for which you are requesting the pdf URLs
    RecordId Guid Unique identifier of the return.
Customization object Contains PDF customizations
    TINMaskType string Optional Mention whether you want the TIN to be masked in the PDF. If masked, only the last digits of the SSN will be visible and the rest of the digits will be crossed (xxx-xx-1234).
Allowed values: "MASKED", "UNMASKED", "BOTH"

Response Body

Field Type Description
SubmissionId Guid Unique identifier of a submission.
FormW2GRecords object Contains success and error records of the requested RecordIds.
    SuccessRecords object[] Contains the successful records with pdf urls if the forms are generated.
        RecordId Guid Unique identifier of the return.
        Status string Status of the PDF in TaxBandits.
Success - The PDF is generated and you can download it.
        Files object Contains multiple copies of a particular return.
            Copy1 object Copy 1: For State, City, or Local Tax Department.
                Unmasked string Link to download the Unmasked copy
                Masked string Link to download the Masked copy
            Copy2 object Copy 2: File this copy with your state, city, or local income tax return, when required.
                Unmasked string Link to download the Unmasked copy
                Masked string Link to download the Masked copy
            CopyB object Copy B: Report this income on your federal tax return. If this form shows federal income tax withheld in box 4, attach this copy to your return.
                Unmasked string Link to download the Unmasked copy
                Masked string Link to download the Masked copy
            CopyC object Copy C: For Recipient's Records
                Unmasked string Link to download the Unmasked copy
                Masked string Link to download the Masked copy
            CopyD object Copy D: For Payer
                Unmasked string Link to download the Unmasked copy
                Masked string Link to download the Masked copy
    ErrorRecords object[] Contains the error records
        RecordId Guid Unique identifier of the return.
        Status string Status of the error record.
  • PDF_Not_Generated - PDF is yet to be generated. You will have to wait and send a new API request to get the PDF.
  • Not Transmitted - The return is not transmitted yet.
  • Invalid RecordId - Given record id is invalid
        Message string Description of each statuses
Errors object[] Lists the errors in the API call
    Id string Returns the error Id.
    Name string Name of the validation error
    Message string Description of the validation error

Sample Request JSON 1

{
  "SubmissionId": "9042f8a6-903c-4c6d-8f64-787702bf9423",
  "RecordIds": [
    {
      "RecordId": "e6270427-42a2-46fc-8d90-29a0f5d975e9"
    }
  ],
  "Customization": {
    "TINMaskType": "Masked"
  }
}
1
2
3
4
5
6
7
8
9
10
11

Sample Response JSON 1

{
   "SubmissionId": "5a545cec-2d0a-42c1-b28c-f98dce815bcb",
   "FormW2GRecords": {
       "SuccessRecords": [
           {
               "RecordId": "15430b5d-056a-4989-8293-6ce2905874c5",
               "Status": "Success",
               "Files": {
                   "Copy1": {
                       "Unmasked": null,
                       "Masked": "https://expressirsforms.s3.us-east-1.amazonaws.com/pdfs/7dbfa93b-1b4e-4870-a875-b3636d875522/1e9ed204-870f-4b61-acac-6c3ecf11abf6/w2g/1ea671fa-b5d2-457d-8eb6-3258a63e4e22/m/copy1_1up_9813933987.pdf"
                   },
                   "Copy2": {
                       "Unmasked": null,
                       "Masked": "https://expressirsforms.s3.us-east-1.amazonaws.com/pdfs/7dbfa93b-1b4e-4870-a875-b3636d875522/1e9ed204-870f-4b61-acac-6c3ecf11abf6/w2g/1ea671fa-b5d2-457d-8eb6-3258a63e4e22/m/copy2_1up_3290074752.pdf"
                   },
                   "CopyB": {
                       "Unmasked": null,
                       "Masked": "https://expressirsforms.s3.us-east-1.amazonaws.com/pdfs/7dbfa93b-1b4e-4870-a875-b3636d875522/1e9ed204-870f-4b61-acac-6c3ecf11abf6/w2g/1ea671fa-b5d2-457d-8eb6-3258a63e4e22/m/copyb_1up_7371939981.pdf"
                   },
                   "CopyC": {
                       "Unmasked": null,
                       "Masked": "https://expressirsforms.s3.us-east-1.amazonaws.com/pdfs/7dbfa93b-1b4e-4870-a875-b3636d875522/1e9ed204-870f-4b61-acac-6c3ecf11abf6/w2g/1ea671fa-b5d2-457d-8eb6-3258a63e4e22/m/copyc_1up_2487057781.pdf"
                   },
                   "CopyD": {
                       "Unmasked": null,
                       "Masked": null
                   }
               }
           }
       ],
       "ErrorRecords": null
   },
   "Errors": null
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35

Sample Request JSON 2

{
 "SubmissionId": "a863c015-91f1-4128-84fc-bb38922b80f9",
 "RecordIds": [
   {
     "RecordId": "c4446e74-ee11-43e4-b9db-a7e870714267"
   },
   {
     "RecordId": "f11413f7-3fe3-4d55-9e87-66b687bc404e"
   }
 ],
 "Customization": {
   "TINMaskType": "Masked"
 }
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14

Sample Response JSON 2

{
   "SubmissionId": null,
   "FormW2GRecords": {
       "SuccessRecords": null,
       "ErrorRecords": [
           {
               "RecordId": "c4446e74-ee11-43e4-b9db-a7e870714267",
               "Status": "PDF_Not_Generated",
               "Message": "Your PDF request is prioritized in the queue.Please try again after sometime"
           },
           {
               "RecordId": "f11413f7-3fe3-4d55-9e87-66b687bc404e",
               "Status": "Not Transmitted",
               "Message": "Given RecordId is not transmitted"
           }
       ]
   },
   "Errors": null
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19

Sample Request JSON 3

{
   "RecordIds": [
   {
     "RecordId": "c4446e74-ee11-43e4-b9db-a7e870714267"
   },
   {
     "RecordId": "f11413f7-3fe3-4d55-9e87-66b687bc404e"
   }
 ]

}
1
2
3
4
5
6
7
8
9
10
11

Sample Response JSON 3

{
   "SubmissionId": null,
   "FormW2GRecords": {
       "SuccessRecords": null,
       "ErrorRecords": [
           {
               "RecordId": "c4446e74-ee11-43e4-b9db-a7e870714267",
               "Status": "PDF_Not_Generated",
               "Message": "Your PDF request is prioritized in the queue.Please try again after sometime"
           },
           {
               "RecordId": "f11413f7-3fe3-4d55-9e87-66b687bc404e",
               "Status": "Not Transmitted",
               "Message": "Given RecordId is not transmitted"
           }
       ]
   },
   "Errors": null
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19

# Status

This method will return the current status of Form 1099 for a particular submission or for a particular employee.

Federal Return Statuses:

  • Created: Form 1099 has been created and not yet transmitted by the user.

  • Transmitted: Form 1099 has been transmitted by the user.

  • Order Received: Form 1099 order is received and waiting in our efile queue.

  • Under Process: Our efile system is processing the Form 1099 which will be sent to the IRS soon.

  • Sent to Agency: Form 1099 has been sent to the SSA and we are waiting for the result from IRS.

  • Accepted: Form 1099 is accepted by the IRS.

  • Rejected: Form 1099 is rejected by the IRS due to some errors. Please correct the errors and retransmit them.

Postal Mailing Statuses:

  • Not Created: Postal Mailing is not opted for the return. IsPostalMailing in the submission manifest must be set as TRUE to enable postal mailing. Postal Mailing cannot be created for recipients with Foreign addresses.

  • Created: Postal Mailing service is opted for the return and it will be sent as soon as the form is transmitted.

  • Order Received: Postal Mailing order has been received and the mails will be sent out soon.

  • Order Sent: Postal Mailing order has been sent and the recipient will receive the copy soon.

GET FormW2G/Status
1

Request Body

Field Type Description
SubmissionId Guid Unique identifier of a submission
RecordIds Guid[] List of record Ids to get the status of Form W2-G.

Response Body

Field Type Description
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

Request JSON

FormW2G/Status?SubmissionId=240dfc90-d019-47bb-96cc-c4ccf49a9d91&RecordIds=8ef67738-b6f1-4825-84a3-d246a3f92c7d
1

Response JSON

{
   "StatusCode": 200,
   "StatusName": "Ok",
   "StatusMessage": "Successful API call",
   "SubmissionId": "240dfc90-d019-47bb-96cc-c4ccf49a9d91",
   "BusinessId": "c0a20f18-2f20-4da1-8943-826a27a14235",
   "PayerRef": "124",
   "Form1099Type": "W2G",
   "Form1099Records": {
       "SuccessRecords": [
           {
               "SequenceId": "1",
               "RecordId": "8ef67738-b6f1-4825-84a3-d246a3f92c7d",
               "RecipientId": "6c8b6616-3e1a-44fa-8c14-895c6b7a85d1",
               "FederalReturn": {
                   "Status": "CREATED",
                   "StatusTs": "2022-03-31 06:35:05 -04:00",
                   "Info": null
               },
               "Postal": {
                   "Status": null,
                   "StatusTs": null,
                   "Info": "This service will be available soon"
               },
               "OnlineAccess": {
                   "Status": "NA",
                   "Email": null,
                   "Info": "This service will be available soon"
               },
               "ScheduleFiling": {
                   "ScheduledOn": null,
                   "Info": "This service will be available soon"
               }
           }
       ],
       "ErrorRecords": null
   },
   "Errors": null
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39

# Transmit

Transmits the Form W2-G return to the IRS. You can Transmit a return successfully only if there are no validation errors in the return.

POST FormW2G/Transmit
1

Request Body

Field Type Description
SubmissionId guid A unique identifier generated by TaxBandits when a W2-G return is created. Mention the W2-G return's Submission ID that you want to transmit.
RecordIds Guid[] A unique identifier generated by TaxBandits when a W2-G return is created. Mention the W2-G return's Record ID that you want to transmit.

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
FormW2GRecords object Pulls the Form W2-G records with Success and Error statuses
    SuccessRecords object[] It will show the detailed information about the success status of Form W2 G Records
        SequenceId string A 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
        Status string Returns the status of the records.
        StatusTs string Date and Time of the Return Transmission
    ErrorRecords object[] It will show the detailed information about the error status of Form W2 G Records.
        SequenceId string A 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

Request JSON

{
  "SubmissionId": "05c4cfa0-aac5-491c-b5c3-95630933d3e7",
  "RecordIds": [
    "1ece3ab0-381e-401d-81eb-93f500f9b493"
  ]
}
1
2
3
4
5
6

Response JSON

{
   "StatusCode": 200,
   "StatusName": "Ok",
   "StatusMessage": "Successful API call",
   "SubmissionId": "05c4cfa0-aac5-491c-b5c3-95630933d3e7",
   "FormW2GRecords": {
       "SuccessRecords": [
           {
               "SequenceId": "1",
               "RecordId": "1ece3ab0-381e-401d-81eb-93f500f9b493",
               "Status": "Transmitted",
               "StatusTs": "2022-05-06 08:02:14 -04:00",
               "StateReturns": null,
               "OnlineAccess": null
           }
       ],
       "ErrorRecords": null
   },
   "Errors": null
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20

# 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
1

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: "2021"
    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 Postal Order will be created when the value is set as True. Once the return is Transmitted, Form W2-G 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 W2-G Recipient 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: ..80
        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: ..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
        Email string Email address of the Business
Size Range: ..40
        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"
        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: ..35
            Address2 string Optional Employer/Payer's suite or apartment
Size Range: ..35
            City string Employer/Payer's city
Size Range: ..27
            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: 9
        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: ..35
            Address2 string Optional Employer/Payer's suite or apartment
Size Range: ..35
            City string Employer/Payer's city
Size Range: ..27
            ProvinceOrStateNm string Employer/Payer's province or state name
Size Range: ..30
            Country string Employer/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"
            PostalCd string Employer/Payer's postal code
Size Range: 9
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 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 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
        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: ..35
            Address2 string Optional Recipient's suite or apartment
Size Range: ..35
            City string Recipient's city
Size Range: ..27
            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: 9
        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: ..35
            Address2 string Optional Recipient's suite or apartment
Size Range: ..35
            City string Recipient's city.
Size Range: ..27
            ProvinceOrStateNm string Recipient's Province or State Name.
Size Range: ..30
            Country string Recipient'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"
            PostalCd string Recipient's Postal Code
Size Range: 9
        Email string Recipient's email address.
Size Range: 0..40
        Fax string Optional Recipient's Fax number.
Size Range: 10
        Phone string 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

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

Request JSON

{
   "SubmissionManifest": {
       "SubmissionId": "05c4cfa0-aac5-491c-b5c3-95630933d3e7",
       "TaxYear": "2021",
       "IsFederalFiling": true,
       "IsStateFiling": true,
       "IsPostal": true,
       "IsOnlineAccess": true,
       "IsScheduleFiling": true,
       "ScheduleFiling": {
           "EfileDate": "12/24/2022"
       }
   },
   "ReturnHeader": {
       "Business": {
           "BusinessId": "7f90187a-0586-4882-92d6-95014a964003",
           "BusinessNm": "Nidok Kodak Com",
           "PayerRef": "8965",
           "TradeNm": "Origano",
           "IsEIN": true,
           "EINorSSN": "512822245",
           "Email": "johnkin@speedo.com",
           "ContactNm": "John Kaiser",
           "Phone": "1234567890",
           "PhoneExtn": "12345",
           "Fax": "1234567890",
           "BusinessType": "ESTE",
           "SigningAuthority": {
               "Name": "John",
               "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": "1ece3ab0-381e-401d-81eb-93f500f9b493",
           "SequenceId": "1",
           "Recipient": {
               "RecipientId": "5698c1b7-89e3-4635-91c0-e9db8c12a83b",
               "TINType": "SSN",
               "TIN": "292187572",
               "FirstPayeeNm": "Mark",
               "SecondPayeeNm": "Davis",
               "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": "johnkaiser@dema.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"
               }
           }
       }
   ]
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108

Response JSON

{
   "StatusCode": 200,
   "StatusName": "Ok",
   "StatusMessage": "Successful API call",
   "SubmissionId": "05c4cfa0-aac5-491c-b5c3-95630933d3e7",
   "BusinessId": "7f90187a-0586-4882-92d6-95014a964003",
   "PayerRef": "8965",
   "Form1099Type": "W2G",
   "FormW2GRecords": {
       "SuccessRecords": [
           {
               "SequenceId": "1",
               "RecordId": "1ece3ab0-381e-401d-81eb-93f500f9b493",
               "RecipientId": "5698c1b7-89e3-4635-91c0-e9db8c12a83b",
               "FederalReturn": {
                   "Status": "CREATED",
                   "StatusTs": "2022-05-06 07:28:51 -04:00",
                   "Info": null
               },
               "Postal": {
                   "Status": null,
                   "StatusTs": null,
                   "Info": "This Service will be available soon"
               },
               "OnlineAccess": {
                   "Status": null,
                   "Email": null,
                   "Info": "This Service will be available soon"
               },
               "ScheduleFiling": {
                   "ScheduledOn": null,
                   "Info": "This Service will be available soon"
               }
           }
       ],
       "ErrorRecords": null
   },
   "Errors": null
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39

# Validate

Executes business and data validation checks for the W2-G returns already created in API. Use the Submission ID and Record IDs of the return to validate.

GET FormW2G/Validate
1

Request Body

Field Type Description
SubmissionId Guid Unique identifier of a submission
RecordIds Guid[] A unique identifier generated by TaxBandits when a W2G-G return is created. Mention the W2-G return's Record ID that you want to Validate.

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
Form1099Records object Pulls the Form W2-G records with Success and Error statuses
    SuccessRecords object[] It will show the detailed information about the success status of Form 1099 Records
        SequenceId string A 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 Record ID of the returns that were successfully validated.
        Status string Returns the status of the records.
        StatusTs string Date and time of return created.
    ErrorRecords object[] It will show the detailed information about the error status of Form 1099 Records.
        SequenceId string A 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

Request JSON

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

Response JSON

{
   "StatusCode": 200,
   "StatusName": "Ok",
   "StatusMessage": "Successful API call",
   "SubmissionId": "05c4cfa0-aac5-491c-b5c3-95630933d3e7",
   "Form1099Records": {
       "SuccessRecords": [
           {
               "SequenceId": "1",
               "RecordId": "1ece3ab0-381e-401d-81eb-93f500f9b493",
               "Status": "CREATED",
               "StatusTs": "2022-05-06 07:31:38 -04:00",
               "StateReturns": null,
               "OnlineAccess": null
           }
       ],
       "ErrorRecords": null
   },
   "Errors": null
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20

# ValidateForm

Validates the Forms in the request against IRS Business rules and field specification without creating the returns in TaxBandits.

POST FormW2G/ValidateForm
1

Request Body

Field Type Description
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: "2021"
    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
        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: ..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
        Email string Email address of the Business
Size Range: ..40
        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"
        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: ..35
            Address2 string Optional Employer/Payer's suite or apartment
Size Range: ..35
            City string Employer/Payer's city
Size Range: ..27
            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: 9
        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: ..35
            Address2 string Optional Employer/Payer's suite or apartment
Size Range: ..35
            City string Employer/Payer's city
Size Range: ..27
            ProvinceOrStateNm string Employer/Payer's province or state name
Size Range: ..30
            Country string Employer/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"
            PostalCd string Employer/Payer's postal code
Size Range: 9
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
        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: ..35
            Address2 string Optional Recipient's suite or apartment
Size Range: ..35
            City string Recipient's city
Size Range: ..27
            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: 9
        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: ..35
            Address2 string Optional Recipient's suite or apartment
Size Range: ..35
            City string Recipient's city.
Size Range: ..27
            ProvinceOrStateNm string Recipient's Province or State Name.
Size Range: ..30
            Country string Recipient'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"
            PostalCd string Recipient's Postal Code
Size Range: 9
        Email string Recipient's email address.
Size Range: 0..40
        Fax string Optional Recipient's Fax number.
Size Range: 10
        Phone string 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

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
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 code
    Name string Name of the validation error
    Message string Description of the validation error

Request JSON

{
   "SubmissionManifest": {
       "SubmissionId": null,
       "TaxYear": "2021",
       "IsFederalFiling": true,
       "IsStateFiling": true,
       "IsPostal": true,
       "IsOnlineAccess": true,
       "IsScheduleFiling": true,
       "ScheduleFiling": {
           "EfileDate": "12/24/2022"
       }
   },
   "ReturnHeader": {
       "Business": {
           "BusinessId": null,
           "BusinessNm": "Nidok Kodak Com",
           "PayerRef": "8965",
           "TradeNm": "Origano",
           "IsEIN": true,
           "EINorSSN": "512822245",
           "Email": "johnkin@speedo.com",
           "ContactNm": "John Kaiser",
           "Phone": "1234567890",
           "PhoneExtn": "12345",
           "Fax": "1234567890",
           "BusinessType": "ESTE",
           "SigningAuthority": {
               "Name": "John",
               "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",
           "Recipient": {
               "RecipientId": null,
               "TINType": "SSN",
               "TIN": "292187572",
               "FirstPayeeNm": "Mark",
               "SecondPayeeNm": "Davis",
               "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": "johnkaiser@dema.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"
               }
           }
       }
   ]
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108

Response JSON

{
   "StatusCode": 200,
   "StatusName": "Ok",
   "StatusMessage": "Successful API call",
   "ErrorRecords": null,
   "Errors": null
}
1
2
3
4
5
6
7

← FormW3C →