# Form1099G
# Create
Creates Form 1099-G returns in TaxBandits. You can send multiple 1099-G 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 1099 G API.
POST Form1099G/Create
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 1099 G to be filed.. Allowed values: "2021" |
IsFederalFiling | Boolean | Federal Filing for the return will be enabled when the value is True. Form 1099-G will be sent directly to the IRS. |
IsStateFiling | Boolean | State Filing for the return will be enabled when the value is True. Form 1099-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 1099-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 1099-G Recipient copies from the portal. |
IsScheduleFiling | Boolean | When true, schedule filing services will be provided for Form 1099 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 response to the Business CREATE Endpoint. By giving the Business Id, you do not have to provide all the business information again. If you do not have a Business Id, ignore the field. |
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 operatesSize 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 |
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 numberSize Range: ..5 |
Fax | string | Optional Fax number of the BusinessSize Range: 10 |
BusinessType | string | Optional Type of business. Optional for W-2/1099 and mandatory for 94X seriesSize 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 authoritySize Range: ..35 |
Phone | string | Optional Phone number of the signing authoritySize Range: 10 |
BusinessMemberType | string | Optional Business title of the signing authoritySize 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 1099-G and 94X seriesAllowed values: "FEDERALGOVT", "STATEORLOCAL501C", "NONGOVT501C", "STATEORLOCALNON501C", "NONEAPPLY" |
KindOfPayer | string | Optional Identifies the kind of payer. This field is mandatory in W-2 and optional in 1099-G and 94X seriesAllowed 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 apartmentSize 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 apartmentSize 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 1099 G details. |
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. 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 | TaxBandits generates a unique ID for each recipient after the return is created and 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 | Enter the nine-digit taxpayer identification number of the Recipient (SSN, ITIN, ATIN, or EIN). Size Range: 9 |
FirstPayeeNm | string | Enter 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, it identifies the recipient's 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 apartmentSize 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 apartmentSize 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 |
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 |
1099GFormData | object | Object to create 1099-G. |
B1UnempComp | number | Unemployment Compensation - Get payments of $10 or more in unemployment compensation, before any income tax was withheld. Size Range: 0-9999999999.99 |
B2TaxRefunds | number | State or Local Income Tax Refunds, Credits, or Offsets - Get refunds, credits, or offsets of state or local income tax of $10 or more you made to recipients. Size Range: 0-9999999999.99 |
B3TaxYearOfB2Amt | string | Box 2 Amount Is For Tax Year Get the year for which the refund, credit, or offset was made. Get the year in "YYYY" Format. Allowed values: "2019","2020" |
B4FedTaxWH | number | Federal Income Tax Withheld - Get backup withholding on payments required or any voluntary federal withholding on unemployment compensation. Size Range: 0-9999999999.99 |
B5RTAAPayments | number | RTAA Payments - Get RTAA payments of $600 or more that paid to eligible individuals under the Reemployment Trade Adjustment Assistance program. Size Range: 0-9999999999.99 |
B6TaxableGrants | number | Taxable Grants - Get any amount of a taxable grant administered by a federal, state, or local program. Size Range: 0-9999999999.99 |
B7AgriPayments | number | Agriculture Payments - Get agricultural subsidy payments made during the year. Size Range: 0-9999999999.99 |
B8IsTradeOrBizIncome | Boolean | When true, the amount in box 2 is a refund, credit, or offset attributable to an income tax that applies exclusively to income from a trade or business and is not a tax of general application. |
B9MarketGain | number | Market Gain - Get market gain associated with the repayment of a CCC loan. Size Range: 0-9999999999.99 |
AccountNum | string | Account number of Payer having multiple accounts for a recipient for whom more than one Form 1099-G is filed. Size Range: 4..20 |
Is2ndTINnot | Boolean | When true, identifies a Payer who is notified by the IRS twice within 3 calendar years for providing an incorrect TIN and do not want the IRS to send any more notices. |
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 |
StateWH | number | Income tax amount withheld for State. 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 1099 G records with Success and Error statuses |
SuccessRecords | object[] | It will show detailed information about the success status of Form 1099 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 | A unique identifier generated by TaxBandits when a 1099-G return is created. |
RecipientId | Guid | A unique identifier generated by TaxBandits for a Recipient when a 1099-G return is created. You can use this id for your future reference to Update. |
AccountNum | string | Account number of Payer having multiple accounts for a recipient for whom more than one Form 1099-G is filed. Size Range: 4..20 |
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. |
StateReturns | object[] | Returns collection of state returns information |
StateCd | string | Returns the state code of the state for which the return is filed. |
Status | string | Returns the record status of the state return. |
StatusTs | string | Date and time of the return created. |
Info | string | Returns the information about the state for which we are not supporting state filing. |
Errors | object[] | Shows error information in state returns of Form 1099 G |
Id | string | Returns the validation error Id. |
Name | string | Name of the validation error. |
Message | string | Description of the validation error. |
Postal | object | Returns the status and StatusTs of postal mailing service for Form 1099 G. |
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 1099 G return. |
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 1099 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
{
"SubmissionManifest": {
"TaxYear": "2021",
"IsFederalFiling": true,
"IsStateFiling": true,
"IsPostal": true,
"IsOnlineAccess": true,
"IsScheduleFiling": true,
"ScheduleFiling": {
"EfileDate": "11/25/2021"
}
},
"ReturnHeader": {
"Business": {
"BusinessId": null,
"PayerRef":"1456",
"BusinessNm": "Kenneth LLC",
"TradeNm": "Kenneth Corporate Services",
"IsEIN": true,
"EINorSSN": "049133861",
"Email": "Ken@gmail.com",
"ContactNm": "Kenne ",
"Phone": "9500099600",
"PhoneExtn": "12345",
"Fax": null,
"BusinessType": "ESTE",
"SigningAuthority": {
"Name": "Jeffery",
"Phone": "1234578960",
"BusinessMemberType": "ADMINISTRATOR"
},
"KindOfEmployer": "FEDERALGOVT",
"KindOfPayer": "REGULAR941",
"IsBusinessTerminated": true,
"IsForeign": false,
"USAddress": {
"Address1": "22 Nord Avenue",
"Address2": "Louis St",
"City": "Seattle",
"State": "WA",
"ZipCd": "98944"
},
"ForeignAddress": null
}
},
"ReturnData": [
{
"RecordId": null,
"SequenceId": "001",
"Recipient": {
"RecipientId": null,
"TINType": "EIN",
"TIN": "391100581",
"FirstPayeeNm": "Brandon",
"SecondPayeeNm": "Jeremy",
"IsForeign": false,
"USAddress": {
"Address1": "1832 Domnie Rd",
"Address2": "Main St",
"City": "Dothan",
"State": "AL",
"ZipCd": "36303"
},
"ForeignAddress": {
"Address1": null,
"Address2": null,
"City": null,
"ProvinceOrStateNm": null,
"Country": null,
"PostalCd": null
},
"Email": "Brandon@gmail.com",
"Fax": "1234567890",
"Phone": "9677275483"
},
"GFormData": {
"B1UnempComp": 7000.27,
"B2TaxRefunds": 90,
"B3TaxYearOfB2Amt": 2020,
"B4FedTaxWH": 70.23,
"B5RTAAPayments": 0,
"B6TaxableGrants": 0,
"B7AgriPayments": 0,
"B8IsTradeOrBizIncome": false,
"B9MarketGain": 0,
"Is2ndTINnot": false,
"AccountNum": "587879879879",
"States": [
{
"StateCd": "PA",
"StateWH": 15.56,
"StateIdNum": "99999999"
},
{
"StateCd": "AZ",
"StateWH": 17.45,
"StateIdNum": "99-9999999"
}
]
}
}
]
}
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
Response JSON
{
"StatusCode": 200,
"StatusName": "Ok",
"StatusMessage": "Successful API call",
"SubmissionId": "0304885f-6cad-45c8-961f-06ee47a7fd07",
"BusinessId": "68183ab2-9d43-4b80-9c52-1dd0a30c836c",
"PayerRef": "1456",
"Form1099Type": "G",
"Form1099Records": {
"SuccessRecords": [
{
"SequenceId": "001",
"RecordId": "8a6cd25b-ec48-4701-8b98-a412e86e0465",
"RecipientId": "60637750-1721-42c4-8213-5a725453e444",
"AccountNum": "587879879879",
"FederalReturn": {
"Status": "CREATED",
"StatusTs": "2021-11-24 08:33:02 -05:00",
"Info": null
},
"StateReturns": [
{
"StateCd": "PA",
"Status": "NA",
"StatusTs": null,
"Info": "This service will be available soon"
},
{
"StateCd": "AZ",
"Status": "NA",
"StatusTs": null,
"Info": "This service will be available soon"
}
],
"Postal": {
"Status": "CREATED",
"StatusTs": "2021-11-24 08:33:02 -05:00",
"Info": null
},
"OnlineAccess": {
"Status": "CREATED",
"Email": "john@gmail.com",
"Info": null
},
"ScheduleFiling": {
"ScheduledOn": null,
"Info": "This Service will be available soon"
}
}
],
"ErrorRecords": null
},
"Errors": null
}
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
# Delete
Deletes Form 1099-G return created in TaxBandits. Transmitted forms cannot be deleted.
DELETE Form1099G/Delete
Request Body
Field | Type | Description |
---|---|---|
SubmissionId | Guid | Unique identifier of a submission |
RecordIds | guid[] | An unique identifier generated by TaxBandits when a 1099-G return is created. Mention the 1099-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 1099 G records with Success and Error statuses |
SuccessRecords | object[] | It will show the detailed information about the success status of Form 1099 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 1099 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
Form1099G/Delete?SubmissionId=daea186d-9d01-4978-ab2b-534085ae5a6e&RecordIds=0b04d901-077f-4757-83de-3377eeb1d4be
Response JSON
{
"StatusCode": 200,
"StatusName": "Ok",
"StatusMessage": "Successful API call",
"SubmissionId": "daea186d-9d01-4978-ab2b-534085ae5a6e",
"Form1099Records": {
"SuccessRecords": [
{
"SequenceId": "001",
"RecordId": "0b04d901-077f-4757-83de-3377eeb1d4be",
"Status": "DELETED",
"StatusTs": "2021-11-24 09:30:29 -05:00",
"StateReturns": null
}
],
"ErrorRecords": null
},
"Errors": null
}
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
# Get
Retrieves the Form 1099-G return information based on the Submission Id and RecordIds given in the request.
GET Form1099G/Get
Request Body
Field | Type | Description |
---|---|---|
SubmissionId | Guid | A unique identifier generated by TaxBandits when a 1099-G return is created. Mention the Form 1099-G return's Submission Id that you want to get. |
RecordIds | Guid[] | A unique identifier generated by TaxBandits when a 1099-G return is created. Mention the Form 1099-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 |
Form1099Records | object | Contains information about Form 1099 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, 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 1099 G to be filed. Allowed values: "2021" |
IsFederalFiling | Boolean | Federal Filing for the return will be enabled when the value is True. The Form 1099-G will be sent directly to the IRS. |
IsStateFiling | Boolean | State Filing for the return will be enabled when the value is True. Form 1099-G forms 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 1099-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 1099-G Recipient copies from the portal. |
IsScheduleFiling | Boolean | When true, schedule filing services will be provided for Form 1099 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 | Returns the unique Business ID for the Business. It can be used in future to refer the same business. |
PayerRef | string | 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 |
BusinessNm | string | Name of the business Size Range: ..80 |
TradeNm | string | Optional Name under which the business operatesSize Range: ..80 |
IsEIN | Boolean | When true, identifies the business with an EIN. |
EINorSSN | string | Returns the Employer Identification Number of Business Size Range: 9 |
string | Email address of the Business Size Range: ..40 | |
ContactNm | string | Optional Name of the person who can be contacted by the IRSSize Range: ..27 |
Phone | string | Phone number of the business Size Range: 10 |
PhoneExtn | string | Optional Extension of the business phone numberSize Range: ..5 |
Fax | string | Optional Fax number of the BusinessSize Range: 10 |
BusinessType | string | Optional Type of business. Optional for W-2/1099 and mandatory for 94X seriesSize 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 authoritySize Range: ..35 |
Phone | string | Optional Phone number of the signing authoritySize Range: 10 |
BusinessMemberType | string | Optional Business title of the signing authoritySize 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 Form 1099-G and 94X seriesAllowed values: "FEDERALGOVT", "STATEORLOCAL501C", "NONGOVT501C", "STATEORLOCALNON501C", "NONEAPPLY" |
KindOfPayer | string | Optional Identifies the kind of payer. This field is mandatory in W-2 and optional in Form 1099-G and 94X seriesAllowed 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 address or post office box of that locality) Size Range: ..35 |
Address2 | string | Optional Employer/Payer's suite or apartmentSize 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 apartmentSize 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 1099 G details. |
RecordId | Guid | Unique identifier of a record. Not required when you are creating a return. |
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. |
Recipient | object | Object to identify the recipient details. |
RecipientId | Guid | An unique identifier generated by TaxBandits for a Recipient when a 1099-G return is created. 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", "N/A" |
TIN | string | Enter the nine-digit taxpayer identification number of the Recipient (SSN, ITIN, ATIN, or EIN). Size Range: 9 |
FirstPayeeNm | string | Enter 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. |
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. |
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 apartmentSize 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 apartmentSize 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 |
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: 10 |
1099GFormData | object | Object to create 1099-G. |
B1UnempComp | number | Unemployment Compensation - Get payments of $10 or more in unemployment compensation, before any income tax was withheld. Size Range: 0-9999999999.99 |
B2TaxRefunds | number | State or Local Income Tax Refunds, Credits, or Offsets - Get refunds, credits, or offsets of state or local income tax of $10 or more you made to recipients. Size Range: 0-9999999999.99 |
B3TaxYearOfB2Amt | string | Box 2 Amount Is For Tax Year Get the year for which the refund, credit, or offset was made. Get the year in "YYYY" Format. Allowed values: "2019","2020" |
B4FedTaxWH | number | Federal Income Tax Withheld - Get backup withholding on payments required or any voluntary federal withholding on unemployment compensation. Size Range: 0-9999999999.99 |
B5RTAAPayments | number | RTAA Payments - Get RTAA payments of $600 or more that paid to eligible individuals under the Reemployment Trade Adjustment Assistance program. Size Range: 0-9999999999.99 |
B6TaxableGrants | number | Taxable Grants - Get any amount of a taxable grant administered by a federal, state, or local program. Size Range: 0-9999999999.99 |
B7AgriPayments | number | Agriculture Payments - Get agricultural subsidy payments made during the year. Size Range: 0-9999999999.99 |
B8IsTradeOrBizIncome | Boolean | When true, the amount in box 2 is a refund, credit, or offset attributable to an income tax that applies exclusively to income from a trade or business and is not a tax of general application. |
B9MarketGain | number | Market Gain - Get market gain associated with the repayment of a CCC loan. Size Range: 0-9999999999.99 |
Is2ndTINnot | Boolean | When true, identifies a Payer who is notified by the IRS twice within 3 calendar years for providing an incorrect TIN and do not want the IRS to send any more notices. |
AccountNum | string | Account number of Payer having multiple accounts for a recipient for whom more than one Form 1099-G is filed. Size Range: 4..20 |
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 |
StateWH | number | Income tax amount withheld for State. 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
Form1099G/Get?SubmissionId=894b9d16-da83-424b-b0f7-41bfd37eb3a7&RecordIds=5c263d8c-fa58-4af4-af14-d109db5f49e7
Response JSON
{
"StatusCode": 200,
"StatusName": "Ok",
"StatusMessage": "Successful API call",
"Form1099Records": {
"SubmissionManifest": {
"SubmissionId": "894b9d16-da83-424b-b0f7-41bfd37eb3a7",
"TaxYear": "2021",
"IsFederalFiling": true,
"IsStateFiling": true,
"IsPostal": true,
"IsOnlineAccess": true,
"IsScheduleFiling": true,
"ScheduleFiling": {
"EfileDate": "11/25/2021"
}
},
"ReturnHeader": {
"Business": {
"BusinessId": "68183ab2-9d43-4b80-9c52-1dd0a30c836c",
"PayerRef": "1456",
"BusinessNm": "Kenneth LLC",
"TradeNm": "Kenneth Corporate Services",
"IsEIN": true,
"EINorSSN": "04-9133861",
"Email": "Ken@gmail.com",
"ContactNm": "Kenne ",
"Phone": "(950) 009-9600",
"PhoneExtn": "12345",
"Fax": null,
"BusinessType": "ESTE",
"SigningAuthority": {
"Name": "Jeffery",
"Phone": "(123) 457-8960",
"BusinessMemberType": "ADMINISTRATOR"
},
"KindOfEmployer": "FEDERALGOVT",
"KindOfPayer": "REGULAR941",
"IsBusinessTerminated": true,
"IsForeign": false,
"USAddress": {
"Address1": "22 Nord Avenue",
"Address2": "Louis St",
"City": "Seattle",
"State": "WA",
"ZipCd": "98944"
},
"ForeignAddress": null,
"IsGovernmentalUnit": false
}
},
"ReturnData": [
{
"RecordId": "5c263d8c-fa58-4af4-af14-d109db5f49e7",
"SequenceId": "001",
"Recipient": {
"RecipientId": "60637750-1721-42c4-8213-5a725453e444",
"TINType": "EIN",
"TIN": "39-1100581",
"FirstPayeeNm": "Brandon",
"SecondPayeeNm": "Jeremy",
"IsForeign": false,
"USAddress": {
"Address1": "1832 Domnie Rd",
"Address2": "Main St",
"City": "Dothan",
"State": "AL",
"ZipCd": "36303"
},
"ForeignAddress": null,
"Email": "Brandon@gmail.com",
"Fax": "(123) 456-7890",
"Phone": "(967) 727-5483"
},
"GFormData": {
"B1UnempComp": 7000.27,
"B2TaxRefunds": 90.00,
"B3TaxYearOfB2Amt": "2020",
"B4FedTaxWH": 70.23,
"B5RTAAPayments": 0.00,
"B6TaxableGrants": 0.00,
"B7AgriPayments": 0.00,
"B8IsTradeOrBizIncome": false,
"B9MarketGain": 0.00,
"Is2ndTINnot": false,
"AccountNum": "587879879879",
"States": [
{
"StateCd": "PA",
"StateIdNum": "99999999",
"StateWH": 15.56
},
{
"StateCd": "AZ",
"StateIdNum": "99-9999999",
"StateWH": 17.45
}
]
}
}
]
},
"Errors": null
}
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
# GetPDF
Retrieves Form 1099 G PDFs. The link for PDFs download will be sent via Webhook after successful API call.
GET Form1099G/GetPDF
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 1099-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 |
Form1099RRecords | object[] | Collection of Form 1099-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
Form1099R/GetPdf?SubmissionId=894b9d16-da83-424b-b0f7-41bfd37eb3a7&RecordIds=5c263d8c-fa58-4af4-af14-d109db5f49e7& TINMaskType=UNMASKED
Response JSON
{
"StatusCode": 200,
"StatusName": "Ok",
"StatusMessage": "Successful API call",
"SubmissionId": "894b9d16-da83-424b-b0f7-41bfd37eb3a7",
"Form1099GRecords": [
{
"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
}
2
3
4
5
6
7
8
9
10
11
12
13
# List
Lists all Form 1099-G returns created and transmitted on the account for a particular Submission or Payer. Form 1099-G returns will be listed based on the filters sent in the Request.
GET Form1099G/List
Request Body
Field | Type | Description |
---|---|---|
SubmissionId | Guid | Unique identifier of a submission |
BusinessId | Guid | Unique identifier of a business |
TINType | string | List the 1099 G records based on the given TINType and TIN. |
TIN | string | List the 1099 G records based on the given TIN. |
TaxYear | string | List the 1099 G records based on the given taxyear. |
Page | number | Pulls the records listed in the page selected |
PageSize | number | Number of 1099 G records to be listed in each page. |
EfileStatus | string | List the 1099 G records based on the status ("CREATED, UNDERPROCESS, SENTTOAGENCY, TRANSMITTED, ACCEPTED, REJECTED") |
FromDate | string | Enter a date from which the Form 1099-G records need to be listed. |
ToDate | string | Enter a date till which the 1099-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 1099 form. |
Form1099Records | object[] | Returns detailed information of the Form 1099 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 1099 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 1099-G return is created. |
RecipientId | Guid | A unique identifier generated by TaxBandits for a Recipient when a 1099-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 1099 G. |
TotalRecords | number | Total number of records. |
TotalPages | number | Total number of pages. |
Page | number | Pulls the records listed in the page selected |
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
Form1099G/List?SubmissionId=894b9d16-da83-424b-b0f7-41bfd37eb3a7&BusinessId=8d6e3938-2af4-41d2-ba02-17796f00aae2&TINType=EIN&TIN=049133861&TaxYear=2021&Page=1&PageSize=10&EfileStatus=ALL&FromDate=11-01-2021&ToDate=11-30-2021
Response JSON
{
"StatusCode": 200,
"StatusName": "Ok",
"StatusMessage": "Successful API call",
"Form1099Type": "G",
"Form1099Records": [
{
"SubmissionId": "894b9d16-da83-424b-b0f7-41bfd37eb3a7",
"BusinessId": "68183ab2-9d43-4b80-9c52-1dd0a30c836c",
"PayerRef": "1456",
"BusinessNm": "Kenneth LLC",
"IsEIN": true,
"EINorSSN": "04-9133861",
"ContactNm": "Kenne ",
"TaxYear": "2021",
"Recipient": {
"SequenceId": "001",
"RecordId": "5c263d8c-fa58-4af4-af14-d109db5f49e7",
"RecipientId": "60637750-1721-42c4-8213-5a725453e444",
"RecipientNm": "Brandon Jeremy",
"TINType": "EIN",
"TIN": "39-1100581",
"Status": "TRANSMITTED"
}
}
],
"TotalRecords": 1,
"TotalPages": 1,
"Page": 1,
"PageSize": 100,
"Errors": null
}
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?
Call the [POST] Form1099G/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 Form1099G/RequestDraftPdfUrl
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 PDFAllowed 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": "cf0a188b-6661-4b57-b04b-ba9ead52a16e",
"Business": null,
"Recipient": null
}
2
3
4
5
6
Response JSON 1
{
"RecordId": "cf0a188b-6661-4b57-b04b-ba9ead52a16e",
"RecipientId": "bd2221f7-4be6-4cc7-813c-6346e23b9f63",
"PayeeRef": null,
"DraftPdfUrl":"https://expressirsforms.s3.us-east-1.amazonaws.com/pdfs/a570efbd-740f-4ae2-bfe7-26356cd85148/3e99f728-e9d4-4d88-99b6-e00638da7a5b/1099/221556/d/copy_tbs_wm_1up_221556.pdf",
"Error": null
}
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
}
}
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/a570efbd-740f-4ae2-bfe7-26356cd85148/3e99f728-e9d4-4d88-99b6-e00638da7a5b/1099/221556/d/copy_tbs_wm_1up_221556.pdf",
"Error": null
}
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 Form1099G/RequestPdfURLs
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. |
Form1099GRecords | 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 Tax Department |
Unmasked | string | Link to download the Unmasked copy |
Masked | string | Link to download the Masked copy |
Copy2 | object | Copy 2: To be filed with recipients state 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: For Recipient |
Unmasked | string | Link to download the Unmasked copy |
Masked | string | Link to download the Masked copy |
CopyC | object | Copy C: 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.
|
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"
}
}
2
3
4
5
6
7
8
9
10
11
Sample Response JSON 1
{
"SubmissionId": "9042f8a6-903c-4c6d-8f64-787702bf9423",
"Form1099GRecords": {
"SuccessRecords": [
{
"RecordId": "e6270427-42a2-46fc-8d90-29a0f5d975e9",
"Status": "Success",
"Files": {
"Copy1": {
"Unmasked": null,
"Masked": "https://expressirsforms.s3.us-east-1.amazonaws.com/pdfs/769e7c15b887-4d64a50f-444ab16f50d0/54b9d9ed-4994-49d0-8264-a14e4c1b0cf1/1099/d21f2496-d8bb-4fda-a01f-0d0af396994b/m/copy1_1up_4391127232.pdf"
},
"Copy2": {
"Unmasked": null,
"Masked": "https://expressirsforms.s3.us-east-1.amazonaws.com/pdfs/769e7c15b887-4d64a50f-444ab16f50d0/54b9d9ed-4994-49d0-8264-a14e4c1b0cf1/1099/d21f2496-d8bb-4fda-a01f-0d0af396994b/m/copy2_1up_2806223371.pdf"
},
"CopyB": {
"Unmasked": null,
"Masked": "https://expressirsforms.s3.us-east-1.amazonaws.com/pdfs/769e7c15b887-4d64a50f-444ab16f50d0/54b9d9ed-4994-49d0-8264-a14e4c1b0cf1/1099/d21f2496-d8bb-4fda-a01f-0d0af396994b/m/copyb_1up_8676595292.pdf"
},
"CopyC": {
"Unmasked": null,
"Masked": "https://expressirsforms.s3.us-east-1.amazonaws.com/pdfs/769e7c15b887-4d64a50f-444ab16f50d0/54b9d9ed-4994-49d0-8264-a14e4c1b0cf1/1099/d21f2496-d8bb-4fda-a01f-0d0af396994b/m/copyc_1up_1831311841.pdf"
}
}
}
],
"ErrorRecords": null
},
"Errors": null
}
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
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"
}
}
2
3
4
5
6
7
8
9
10
11
12
13
14
Sample Response JSON 2
{
"SubmissionId": null,
"Form1099GRecords": {
"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
}
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"
}
]
}
2
3
4
5
6
7
8
9
10
11
Sample Response JSON 3
{
"SubmissionId": null,
"Form1099GRecords": {
"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
}
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.
State Return Statuses:
Not Created: State filing is not opted for the return. IsStateFiling in the submission manifest must be set as TRUE to enable state filing.
Created: Form 1099 state return has been created and not yet transmitted by the user.
Transmitted: Form 1099 state return has been transmitted by the user.
Order Received: State order is received and waiting in our efile queue.
Under Process: Our efile system is processing the Form 1099 for the state which will be sent to the state DOR soon.
Sent to Agency: Form 1099 State return has been sent to the DOR and we are waiting for the result.
Accepted: Form 1099 state return is accepted by the DOR.
Rejected: Form 1099 state return is rejected by the DOR 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.
Online Access Statuses:
Not Created: Online Access service is not opted for the return. IsOnlineAccess in the submission manifest must be set as TRUE to enable Online Access.Email Address is required to create Online Access.
Created: Online Access service is opted for the return and the email with a secure link to download their forms will be sent to the recipients as soon as the form is transmitted.
Order Received: Online Access order has been received and the email will be sent to the recipient soon.
Email Sent: Online Access email with a secure link to download the form has been sent to the recipient and the recipient is yet to view the form.
Viewed Form: Recipient has successfully viewed the form.
Downloaded Form: Recipient has successfully viewed and downloaded the form.
GET Form1099G/Status
Request Body
Field | Type | Description |
---|---|---|
SubmissionId | Guid | Unique identifier of a submission |
RecordIds | Guid[] | List of record Ids to get the status of Form 1099 G. |
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 1099 G records with Success and Error statuses |
SuccessRecords | object[] | It will show the detailed information about the success status of Form 1099 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 | A unique identifier generated by TaxBandits when a 1099-G return is created. |
RecipientId | Guid | A unique identifier generated by TaxBandits for a Recipient when a 1099-G 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. |
StateReturns | object[] | Returns collection of state returns information |
StateCd | string | Returns the state code of the state which the return filed. |
Status | string | Returns the record status of the state return. |
StatusTs | string | Date and time of the return created. |
Info | string | Returns the information about the state for which we are not state filing. |
Errors | object[] | Shows error information of state returns of Form 1099 G |
Id | string | Returns the validation error Id. |
Name | string | Name of the validation error. |
Message | string | Description of the validation error. |
Postal | object | Returns the status and StatusTs of postal mailing service for Form 1099 G. |
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 1099 G return. |
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 1099 G 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
Form1099G/Status?SubmissionId=894b9d16-da83-424b-b0f7-41bfd37eb3a7&RecordIds=5c263d8c-fa58-4af4-af14-d109db5f49e7
Response JSON
{
"StatusCode": 200,
"StatusName": "Ok",
"StatusMessage": "Successful API call",
"SubmissionId": "894b9d16-da83-424b-b0f7-41bfd37eb3a7",
"BusinessId": "68183ab2-9d43-4b80-9c52-1dd0a30c836c",
"PayerRef": "1456",
"Form1099Type": "G",
"Form1099Records": {
"SuccessRecords": [
{
"SequenceId": "001",
"RecordId": "5c263d8c-fa58-4af4-af14-d109db5f49e7",
"RecipientId": "60637750-1721-42c4-8213-5a725453e444",
"FederalReturn": {
"Status": "Transmitted",
"StatusTs": "2021-11-24 09:21:31 -05:00",
"Info": null
},
"StateReturns": [
{
"StateCd": "PA",
"Status": "NA",
"StatusTs": null,
"Info": "This service will be available soon"
},
{
"StateCd": "AZ",
"Status": "NA",
"StatusTs": null,
"Info": "This service will be available soon"
}
],
"Postal": {
"Status": "RECEIVED",
"StatusTs": "2021-11-24 09:22:08 -05:00",
"Info": null
},
"OnlineAccess": {
"Status": "CREATED",
"Email": "john@gmail.com",
"Info": null
},
"ScheduleFiling": {
"ScheduledOn": null,
"Info": "This service will be available soon"
}
}
],
"ErrorRecords": null
},
"Errors": null
}
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
# Transmit
Transmits the Form 1099-G return to the IRS. You can Transmit a return successfully only if there are no validation errors in the return.
POST Form1099G/Transmit
Request Body
Field | Type | Description |
---|---|---|
SubmissionId | guid | A unique identifier generated by TaxBandits when a 1099-G return is created. Mention the 1099-G return's Submission ID that you want to transmit. |
RecordIds | Guid[] | A unique identifier generated by TaxBandits when a 1099-G return is created. Mention the 1099-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 |
Form1099Records | object | Pulls the Form 1099 G records with Success and Error statuses |
SuccessRecords | object[] | It will show the detailed information about the success status of Form 1099 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 1099 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": "894b9d16-da83-424b-b0f7-41bfd37eb3a7",
"RecordIds": [
"5c263d8c-fa58-4af4-af14-d109db5f49e7"
]
}
2
3
4
5
6
Response JSON
{
"StatusCode": 200,
"StatusName": "Ok",
"StatusMessage": "Successful API call",
"SubmissionId": "894b9d16-da83-424b-b0f7-41bfd37eb3a7",
"Form1099Records": {
"SuccessRecords": [
{
"SequenceId": "001",
"RecordId": "5c263d8c-fa58-4af4-af14-d109db5f49e7",
"Status": "Transmitted",
"StatusTs": "2021-11-24 09:21:31 -05:00",
"StateReturns": null
}
],
"ErrorRecords": null
},
"Errors": null
}
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
# Update
Updates the existing Form 1099 G return created in TaxBandits. Use the unique identifiers to refer a particular return. You cannot update a Transmitted return.
PUT Form1099G/Update
Request Body
Field | Type | Description |
---|---|---|
SubmissionManifest | object | SubmissionManifest provides brief information about a particular submission on the whole. It contains information like Submission ID, Tax Year, IsPostal, IsFederalFiling, IsStateFiling, IsOnlineAccess, IsScheduleFiling & ScheduleFiling service details. |
SubmissionId | Guid | Unique identifier created by TaxBandits for each submission. Not required when you are creating a return. |
TaxYear | string | Tax year of Form 1099 G to be filed.. Allowed values: "2021" |
IsFederalFiling | Boolean | Federal Filing for the return will be enabled when the value is True. Form 1099-G will be sent directly to the IRS. |
IsStateFiling | Boolean | State Filing for the return will be enabled when the value is True. Form 1099-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 1099-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 1099-G Recipient copies from the portal. |
IsScheduleFiling | Boolean | When true, schedule filing services will be provided for Form 1099 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 response to the Business CREATE Endpoint. By giving the Business Id, you do not have to provide all the business information again. If you do not have a Business Id, ignore the field. |
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 operatesSize 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 |
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 numberSize Range: ..5 |
Fax | string | Optional Fax number of the BusinessSize Range: 10 |
BusinessType | string | Optional Type of business. Optional for W-2/1099 and mandatory for 94X seriesSize 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 authoritySize Range: ..35 |
Phone | string | Optional Phone number of the signing authoritySize Range: 10 |
BusinessMemberType | string | Optional Business title of the signing authoritySize 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 1099-G and 94X seriesAllowed values: "FEDERALGOVT", "STATEORLOCAL501C", "NONGOVT501C", "STATEORLOCALNON501C", "NONEAPPLY" |
KindOfPayer | string | Optional Identifies the kind of payer. This field is mandatory in W-2 and optional in 1099-G and 94X seriesAllowed 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 apartmentSize 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 apartmentSize 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 1099 G details. |
RecordId | Guid | Unique Identifier of the Record. Mention the Form 1099-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. |
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 |
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 | Enter the nine-digit taxpayer identification number of the Recipient (SSN, ITIN, ATIN, or EIN). Size Range: 9 |
FirstPayeeNm | string | Enter 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, it identifies the recipient's 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 apartmentSize 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 apartmentSize 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 |
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 |
1099GFormData | object | Object to create 1099-G. |
B1UnempComp | number | Unemployment Compensation - Get payments of $10 or more in unemployment compensation, before any income tax was withheld. Size Range: 0-9999999999.99 |
B2TaxRefunds | number | State or Local Income Tax Refunds, Credits, or Offsets - Get refunds, credits, or offsets of state or local income tax of $10 or more you made to recipients. Size Range: 0-9999999999.99 |
B3TaxYearOfB2Amt | string | Box 2 Amount Is For Tax Year Get the year for which the refund, credit, or offset was made. Get the year in "YYYY" Format. Allowed values: "2019","2020" |
B4FedTaxWH | number | Federal Income Tax Withheld - Get backup withholding on payments required or any voluntary federal withholding on unemployment compensation. Size Range: 0-9999999999.99 |
B5RTAAPayments | number | RTAA Payments - Get RTAA payments of $600 or more that paid to eligible individuals under the Reemployment Trade Adjustment Assistance program. Size Range: 0-9999999999.99 |
B6TaxableGrants | number | Taxable Grants - Get any amount of a taxable grant administered by a federal, state, or local program. Size Range: 0-9999999999.99 |
B7AgriPayments | number | Agriculture Payments - Get agricultural subsidy payments made during the year. Size Range: 0-9999999999.99 |
B8IsTradeOrBizIncome | Boolean | When true, the amount in box 2 is a refund, credit, or offset attributable to an income tax that applies exclusively to income from a trade or business and is not a tax of general application. |
B9MarketGain | number | Market Gain - Get market gain associated with the repayment of a CCC loan. Size Range: 0-9999999999.99 |
AccountNum | string | Account number of Payer having multiple accounts for a recipient for whom more than one Form 1099-G is filed. Size Range: 4..20 |
Is2ndTINnot | Boolean | When true, identifies a Payer who is notified by the IRS twice within 3 calendar years for providing an incorrect TIN and do not want the IRS to send any more notices. |
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 |
StateWH | number | Income tax amount withheld for State. 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 the Form 1099 records with Success and Error statuses |
SuccessRecords | object[] | It will show detailed information about the success status of Form 1099 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 | A unique identifier generated by TaxBandits when a 1099-G return is created. |
RecipientId | Guid | A unique identifier generated by TaxBandits for a Recipient when a 1099-G return is created. You can use this id for your future reference to Update. |
AccountNum | string | Account number of Payer having multiple accounts for a recipient for whom more than one Form 1099-G is filed. Size Range: 4..20 |
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. |
StateReturns | object[] | Returns collection of state returns information |
StateCd | string | Returns the state code of the state for which the return is filed. |
Status | string | Returns the record status of the state return. |
StatusTs | string | Date and time of the return created. |
Info | string | Returns the information about the state for which we are not supporting state filing. |
Errors | object[] | Shows error information in state returns of Form 1099 G |
Id | string | Returns the validation error Id. |
Name | string | Name of the validation error. |
Message | string | Description of the validation error. |
Postal | object | Returns the status and StatusTs of postal mailing service for Form 1099 G. |
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 1099 G return. |
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 1099 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
{
"SubmissionManifest": {
"Submissionid":"0304885f-6cad-45c8-961f-06ee47a7fd07",
"TaxYear": "2021",
"IsFederalFiling": true,
"IsStateFiling": true,
"IsPostal": true,
"IsOnlineAccess": true,
"IsScheduleFiling": true,
"ScheduleFiling": {
"EfileDate": "12/14/2021"
}
},
"ReturnHeader": {
"Business": {
"BusinessId": "68183ab2-9d43-4b80-9c52-1dd0a30c836c",
"BusinessNm": "Brian LLC",
"TradeNm": "Brian",
"Email": "brianscott@gmail.com",
"ContactNm": "Brian O Relly",
"Phone": "1234567890",
"PhoneExtn": "12345",
"Fax": null,
"BusinessType": "ESTE",
"SigningAuthority": {
"Name": "Altof",
"Phone": "1234578960",
"BusinessMemberType": "ADMINISTRATOR"
},
"KindOfEmployer": "FEDERALGOVT",
"KindOfPayer": "REGULAR941",
"IsBusinessTerminated": true,
"IsForeign": false,
"USAddress": {
"Address1": "15 Park Avenue",
"Address2": "Louis St",
"City": "Seattle",
"State": "WA",
"ZipCd": "98944"
},
"ForeignAddress": null
}
},
"ReturnData": [
{
"RecordId": "8a6cd25b-ec48-4701-8b98-a412e86e0465",
"SequenceId": "001",
"Recipient": {
"RecipientId": "60637750-1721-42c4-8213-5a725453e444",
"FirstPayeeNm": "John",
"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": "John@gmail.com",
"Fax": "1234567890",
"Phone": "1234567890"
},
"GFormData": {
"B1UnempComp": 70,
"B2TaxRefunds": 9,
"B3TaxYearOfB2Amt": 2011,
"B4FedTaxWH": 70,
"B5RTAAPayments": 0,
"B6TaxableGrants": 0,
"B7AgriPayments": 0,
"B8IsTradeOrBizIncome": false,
"B9MarketGain": 0,
"Is2ndTINnot": false,
"AccountNum": "587879879",
"States": [
{
"StateCd": "KS",
"StateWH": 15,
"StateIdNum": "036999999999F99"
},
{
"StateCd": "AL",
"StateWH": 15,
"StateIdNum": "R007999999"
}
]
}
},
{
"RecordId": null,
"SequenceId": "002",
"Recipient": {
"RecipientId": null,
"TINType": "EIN",
"TIN": "391114512",
"FirstPayeeNm": "Alex",
"SecondPayeeNm": "Davis",
"IsForeign": false,
"USAddress": {
"Address1": "1751",
"Address2": "Mai",
"City": "Dothan",
"State": "KS",
"ZipCd": "36303"
},
"ForeignAddress": {
"Address1": null,
"Address2": null,
"City": null,
"ProvinceOrStateNm": null,
"Country": null,
"PostalCd": null
},
"Email": "Alex@gmail.com",
"Fax": "9876543212",
"Phone": "1234567890"
},
"GFormData": {
"B1UnempComp": 707,
"B2TaxRefunds": 10,
"B3TaxYearOfB2Amt": 2019,
"B4FedTaxWH": 70,
"B5RTAAPayments": 0,
"B6TaxableGrants": 0,
"B7AgriPayments": 0,
"B8IsTradeOrBizIncome": false,
"B9MarketGain": 0,
"Is2ndTINnot": false,
"AccountNum": "587879879879",
"States": [
{
"StateCd": "AR",
"StateWH": 15.56,
"StateIdNum": "99999999-ZZZ"
},
{
"StateCd": "MA",
"StateWH": 15.56,
"StateIdNum": "99999999"
}
]
}
}
]
}
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
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
Response JSON
{
"StatusCode": 200,
"StatusName": "Ok",
"StatusMessage": "Successful API call",
"SubmissionId": "0304885f-6cad-45c8-961f-06ee47a7fd07",
"BusinessId": "68183ab2-9d43-4b80-9c52-1dd0a30c836c",
"PayerRef": "1456",
"Form1099Type": "G",
"Form1099Records": {
"SuccessRecords": [
{
"SequenceId": "001",
"RecordId": "8a6cd25b-ec48-4701-8b98-a412e86e0465",
"RecipientId": "60637750-1721-42c4-8213-5a725453e444",
"AccountNum": "587879879",
"FederalReturn": {
"Status": "CREATED",
"StatusTs": "2021-11-24 08:42:47 -05:00",
"Info": null
},
"StateReturns": [
{
"StateCd": "KS",
"Status": "NA",
"StatusTs": null,
"Info": "This service will be available soon"
},
{
"StateCd": "AL",
"Status": "NA",
"StatusTs": null,
"Info": "This service will be available soon"
}
],
"Postal": {
"Status": "CREATED",
"StatusTs": "2021-11-24 08:42:47 -05:00",
"Info": null
},
"OnlineAccess": {
"Status": "CREATED",
"Email": "john@gmail.com",
"Info": null
},
"ScheduleFiling": {
"ScheduledOn": null,
"Info": "This Service will be available soon"
}
},
{
"SequenceId": "002",
"RecordId": "7e39a894-b7ac-4d65-82d7-11726fa42db3",
"RecipientId": "3e4ccbb4-1841-4ddf-acba-7ed8fe09adb8",
"AccountNum": "587879879879",
"FederalReturn": {
"Status": "CREATED",
"StatusTs": "2021-11-24 08:42:47 -05:00",
"Info": null
},
"StateReturns": [
{
"StateCd": "AR",
"Status": "NA",
"StatusTs": null,
"Info": "This service will be available soon"
},
{
"StateCd": "MA",
"Status": "NA",
"StatusTs": null,
"Info": "This service will be available soon"
}
],
"Postal": {
"Status": "CREATED",
"StatusTs": "2021-11-24 08:42:47 -05:00",
"Info": null
},
"OnlineAccess": {
"Status": "CREATED",
"Email": "Alex@gmail.com",
"Info": null
},
"ScheduleFiling": {
"ScheduledOn": null,
"Info": "This Service will be available soon"
}
}
],
"ErrorRecords": null
},
"Errors": null
}
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
# Validate
Executes business and data validation checks for the 1099 G returns already created in API. Use the Submission ID and Record IDs of the return to validate.
GET Form1099G/Validate
Request Body
Field | Type | Description |
---|---|---|
SubmissionId | Guid | Unique identifier of a submission |
RecordsIds | Guid[] | unique identifier generated by TaxBandits when a 1099-G return is created. Mention the 1099-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 1099 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
Form1099G/Validate?SubmissionId=0304885f-6cad-45c8-961f-06ee47a7fd07&RecordIds=7e39a894-b7ac-4d65-82d7-11726fa42db3
Response JSON
{
"StatusCode": 200,
"StatusName": "Ok",
"StatusMessage": "Successful API call",
"SubmissionId": "0304885f-6cad-45c8-961f-06ee47a7fd07",
"Form1099Records": {
"SuccessRecords": [
{
"SequenceId": "001",
"RecordId": "7e39a894-b7ac-4d65-82d7-11726fa42db3",
"Status": "CREATED",
"StatusTs": "2021-11-24 09:16:18 -05:00",
"StateReturns": null
}
],
"ErrorRecords": null
},
"Errors": null
}
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
# ValidateForm
Validates the Forms in the request against IRS Business rules and field specification without creating the returns in TaxBandits.
POST Form1099G/ValidateForm
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 1099 G to be filed.. Allowed values: "2021" |
IsFederalFiling | Boolean | Federal Filing for the return will be enabled when the value is True. Form 1099-G will be sent directly to the IRS. |
IsStateFiling | Boolean | State Filing for the return will be enabled when the value is True. Form 1099-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 1099-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 1099-G Recipient copies from the portal. |
IsScheduleFiling | Boolean | When true, schedule filing services will be provided for Form 1099 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 response to the Business CREATE Endpoint. By giving the Business Id, you do not have to provide all the business information again. If you do not have a Business Id, ignore the field. |
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 operatesSize 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 |
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 numberSize Range: ..5 |
Fax | string | Optional Fax number of the BusinessSize Range: 10 |
BusinessType | string | Optional Type of business. Optional for W-2/1099 and mandatory for 94X seriesSize 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 authoritySize Range: ..35 |
Phone | string | Optional Phone number of the signing authoritySize Range: 10 |
BusinessMemberType | string | Optional Business title of the signing authoritySize 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 1099-G and 94X seriesAllowed values: "FEDERALGOVT", "STATEORLOCAL501C", "NONGOVT501C", "STATEORLOCALNON501C", "NONEAPPLY" |
KindOfPayer | string | Optional Identifies the kind of payer. This field is mandatory in W-2 and optional in 1099-G and 94X seriesAllowed 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 apartmentSize 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 apartmentSize 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 1099 G details. |
RecordId | Guid | Unique identifier of a record. Not required when you are creating a return. |
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. Size Range: 50 |
Recipient | object | Object to identify the recipient details. |
RecipientId | Guid | TaxBandits generates a unique ID for each recipient after the return is created and 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 | Enter the nine-digit taxpayer identification number of the Recipient (SSN, ITIN, ATIN, or EIN). Size Range: 9 |
FirstPayeeNm | string | Enter 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, it identifies the recipient's 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 apartmentSize 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 apartmentSize 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 |
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 |
1099GFormData | object | Object to create 1099-G. |
B1UnempComp | number | Unemployment Compensation - Get payments of $10 or more in unemployment compensation, before any income tax was withheld. Size Range: 0-9999999999.99 |
B2TaxRefunds | number | State or Local Income Tax Refunds, Credits, or Offsets - Get refunds, credits, or offsets of state or local income tax of $10 or more you made to recipients. Size Range: 0-9999999999.99 |
B3TaxYearOfB2Amt | string | Box 2 Amount Is For Tax Year Get the year for which the refund, credit, or offset was made. Get the year in "YYYY" Format. Allowed values: "2019","2020" |
B4FedTaxWH | number | Federal Income Tax Withheld - Get backup withholding on payments required or any voluntary federal withholding on unemployment compensation. Size Range: 0-9999999999.99 |
B5RTAAPayments | number | RTAA Payments - Get RTAA payments of $600 or more that paid to eligible individuals under the Reemployment Trade Adjustment Assistance program. Size Range: 0-9999999999.99 |
B6TaxableGrants | number | Taxable Grants - Get any amount of a taxable grant administered by a federal, state, or local program. Size Range: 0-9999999999.99 |
B7AgriPayments | number | Agriculture Payments - Get agricultural subsidy payments made during the year. Size Range: 0-9999999999.99 |
B8IsTradeOrBizIncome | Boolean | When true, the amount in box 2 is a refund, credit, or offset attributable to an income tax that applies exclusively to income from a trade or business and is not a tax of general application. |
B9MarketGain | number | Market Gain - Get market gain associated with the repayment of a CCC loan. Size Range: 0-9999999999.99 |
AccountNum | string | Account number of Payer having multiple accounts for a recipient for whom more than one Form 1099-G is filed. Size Range: 4..20 |
Is2ndTINnot | Boolean | When true, identifies a Payer who is notified by the IRS twice within 3 calendar years for providing an incorrect TIN and do not want the IRS to send any more notices. |
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 |
StateWH | number | Income tax amount withheld for State. 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 |
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": {
"TaxYear": "2021",
"IsFederalFiling": true,
"IsStateFiling": true,
"IsPostal": true,
"IsOnlineAccess": true,
"IsScheduleFiling": true,
"ScheduleFiling": {
"EfileDate": "11/25/2021"
}
},
"ReturnHeader": {
"Business": {
"BusinessId": null,
"PayerRef":"1456",
"BusinessNm": "Kenneth LLC",
"TradeNm": "Kenneth Corporate Services",
"IsEIN": true,
"EINorSSN": "049133861",
"Email": "Ken@gmail.com",
"ContactNm": "Kenne ",
"Phone": "9500099600",
"PhoneExtn": "12345",
"Fax": null,
"BusinessType": "ESTE",
"SigningAuthority": {
"Name": "Jeffery",
"Phone": "1234578960",
"BusinessMemberType": "ADMINISTRATOR"
},
"KindOfEmployer": "FEDERALGOVT",
"KindOfPayer": "REGULAR941",
"IsBusinessTerminated": true,
"IsForeign": false,
"USAddress": {
"Address1": "22 Nord Avenue",
"Address2": "Louis St",
"City": "Seattle",
"State": "WA",
"ZipCd": "98944"
},
"ForeignAddress": null
}
},
"ReturnData": [
{
"RecordId": null,
"SequenceId": "001",
"Recipient": {
"RecipientId": null,
"TINType": "EIN",
"TIN": "391100581",
"FirstPayeeNm": "Brandon",
"SecondPayeeNm": "Jeremy",
"IsForeign": false,
"USAddress": {
"Address1": "1832 Domnie Rd",
"Address2": "Main St",
"City": "Dothan",
"State": "AL",
"ZipCd": "36303"
},
"ForeignAddress": {
"Address1": null,
"Address2": null,
"City": null,
"ProvinceOrStateNm": null,
"Country": null,
"PostalCd": null
},
"Email": "Brandon@gmail.com",
"Fax": "1234567890",
"Phone": "9677275483"
},
"GFormData": {
"B1UnempComp": 7000.27,
"B2TaxRefunds": 90,
"B3TaxYearOfB2Amt": 2020,
"B4FedTaxWH": 70.23,
"B5RTAAPayments": 0,
"B6TaxableGrants": 0,
"B7AgriPayments": 0,
"B8IsTradeOrBizIncome": false,
"B9MarketGain": 0,
"Is2ndTINnot": false,
"AccountNum": "587879879879",
"States": [
{
"StateCd": "PA",
"StateWH": 15.56,
"StateIdNum": "99999999"
},
{
"StateCd": "AZ",
"StateWH": 17.45,
"StateIdNum": "99-9999999"
}
]
}
}
]
}
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
Response JSON
{
"StatusCode": 200,
"StatusName": "Ok",
"StatusMessage": "Successful API call",
"Errors": null
}
2
3
4
5
6