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 |
FirstNm | string | First Name of the Individual Size Range: ..20 |
MiddleNm | string | Middle Name of the Individual Size Range: ..20 |
LastNm | string | Last Name of the Individual Size Range: ..20 |
Suffix | string | Suffix of the IndividualAllowed values"Jr", "Sr", "I", "II", "III", "IV", "V", "VI", "VII" |
PayerRef | string | Optional An unique identifier for each payer completing their information. This identifier can be used in future references of the payer in the API. Size Range: ..50 |
TradeNm | string | Optional Name under which the business operates Size Range: ..80 |
IsEIN | Boolean | When true, identify that the business TIN is an EIN. |
EINorSSN | string | When IsEIN is true, use Employer Identification Number (EIN). When IsEIN is false, use Social Security Number (SSN) Size Range: 9-11 |
string | Optional Email address of the Business Size Range: ..100 | |
ContactNm | string | Optional Name of the person who can be contacted by the IRS. Size Range: ..27 |
Phone | string | Optional Phone number of the business Size Range: 10 |
PhoneExtn | string | Optional Extension of the business phone number Size Range: ..5 |
Fax | string | Optional Fax number of the Business Size Range: 10 |
BusinessType | string | Optional Type of business. Optional for W-2/1099 and mandatory for 94X series Size Range: 4 Allowed values"ESTE", "PART", "CORP", "EORG", "SPRO" |
SigningAuthority | object | Optional Details of the person who is authorized to sign the return |
Name | string | Optional Name of the signing authority Size Range: ..35 |
Phone | string | Optional Phone number of the signing authority Size Range: 10 |
BusinessMemberType | string | Optional Business title of the signing authority Size Range: 5..29 Allowed values"CORPORATESECRETARY", "SECRETARYTREASURER", "PARTNER", "GENERALPARTNER", "LIMITEDPARTNER", "LLCMEMBER", "MANAGINGMEMBER", "MANAGER", "TAXMATTERPARTNER", "PRESIDENT", "VICEPRESIDENT", "CORPORATETREASURER", "TREASURER", "ASSISTANTTREASURER", "CHIEFACCOUNTINGOFFICER", "CHIEFEXECUTIVEOFFICER", "CHIEFFINANCIALOFFICER", "TAXOFFICER", "CHIEFOPERATINGOFFICER", "CORPORATEOFFICER", "EXECUTIVEDIRECTOR", "DIRECTOR", "CHAIRMAN", "EXECUTIVEADMINISTRATOR", "RECEIVER", "PASTOR", "ASSISTANTTORELIGIOUSLEADER", "REVEREND", "PRIEST", "MINISTER", "RABBI", "LEADEROFRELIGIOUSORGANIZATION", "SECRETARY", "DIRECTOROFTAXATION", "DIRECTOROFPERSONNEL", "ADMINISTRATOR", "EXECUTOR", "TRUSTEE", "FIDUCIARY", "OWNER", "SOLEPROPRIETOR", "MEMBER", "SOLEMEMBER" |
KindOfEmployer | string | Optional Identifies the kind of employer. Mandatory for W-2 and optional for 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: ..46 |
Address2 | string | Optional Employer/Payer's suite or apartment Size Range: ..46 |
City | string | Employer/Payer's city Size Range: ..50 |
State | string | Employer/Payer's state code. Refer Static values. Size Range: 2 Allowed values"AL", "AK", "AZ", "AR", "CA", "CO", "CT", "DE", "DC", "FL", "GA", "HI", "ID", "IL", "IN", "IA", "KS", "KY", "LA", "ME", "MD", "MA", "MI", "MN", "MS", "MO", "MT", "NE", "NV", "NH", "NJ", "NM", "NY", "NC", "ND", "OH", "OK", "OR", "PA", "RI", "SC", "SD", "TN", "TX", "UT", "VT", "VA", "WA", "WV", "WI", "WY", "AS", "FM", "GU", "MH", "MP", "PW", "PR", "VI", "AA", "AE", "AP" |
ZipCd | string | Employer/Payer's zip code. Size Range: 5..10 |
ForeignAddress | object | If IsForeign is true, pass foreign address of the business |
Address1 | string | Employer/Payer's foreign address (street address or post office box of that locality) Size Range: ..50 |
Address2 | string | Optional Employer/Payer's suite or apartment Size Range: ..50 |
City | string | Employer/Payer's city Size Range: ..50 |
ProvinceOrStateNm | string | Employer/Payer's province or state name Size Range: ..50 |
Country | string | Employer/Payer's country Size Range: 2 Allowed values"AF", "AX", "AL", "AG", "AQ", "AN", "AO", "AV", "AY", "AC", "AR", "AM", "AA", "AT", "AS", "AU", "AJ", "BF", "BA", "FQ", "BG", "BB", "BO", "BE", "BH", "BN", "BD", "BT", "BL", "BK", "BC", "BV", "BR", "IO", "VI", "BX", "BU", "UV", "BM", "BY", "CB", "CM", "CA", "CV", "CJ", "CT", "CD", "CI", "CH", "KT", "IP", "CK", "CO", "CN", "CF", "CG", "CW", "CR", "CS", "IV", "HR", "CU", "UC", "CY", "EZ", "DA", "DX", "DJ", "DO", "DR", "TT", "EC", "EG", "ES", "EK", "ER", "EN", "ET", "FK", "FO", "FM", "FJ", "FI", "FR", "FP", "FS", "GB", "GA", "GG", "GM", "GH", "GI", "GR", "GL", "GJ", "GQ", "GT", "GK", "GV", "PU", "GY", "HA", "HM", "VT", "HO", "HK", "HQ", "HU", "IC", "IN", "ID", "IR", "IZ", "EI", "IS", "IT", "JM", "JN", "JA", "DQ", "JE", "JQ", "JO", "KZ", "KE", "KQ", "KR", "KN", "KS", "KV", "KU", "KG", "LA", "LG", "LE", "LT", "LI", "LY", "LS", "LH", "LU", "MC", "MK", "MA", "MI", "MY", "MV", "ML", "MT", "IM", "RM", "MR", "MP", "MX", "MQ", "MD", "MN", "MG", "MJ", "MH", "MO", "MZ", "WA", "NR", "BQ", "NP", "NL", "NC", "NZ", "NU", "NG", "NI", "NE", "NF", "CQ", "NO", "MU", "OC", "PK", "PS", "LQ", "PM", "PP", "PF", "PA", "PE", "RP", "PC", "PL", "PO", "RQ", "QA", "RO", "RS", "RW", "TB", "RN", "WS", "SM", "TP", "SA", "SG", "RI", "SE", "SL", "SN", "NN", "LO", "SI", "BP", "SO", "SF", "SX", "OD", "SP", "PG", "CE", "SH", "SC", "ST", "SB", "VC", "SU", "NS", "SV", "WZ", "SW", "SZ", "SY", "TW", "TI", "TZ", "TH", "TO", "TL", "TN", "TD", "TS", "TU", "TX", "TK", "TV", "UG", "UP", "AE", "UK", "UY", "UZ", "NH", "VE", "VM", "VQ", "WQ", "WF", "WI", "YM", "ZA", "ZI" |
PostalCd | string | Employer/Payer's postal code Size Range: ..16 |
ReturnData | object[] | Contains information about the recipient details and Form 1099-G details. |
RecordId | Guid | Optional 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 | Optional 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. Note: If the recipient doesn't have a TIN, enter the TIN type as 'NA' and input 'null' in the TIN field. Allowed values"SSN", "EIN", "ITIN", "ATIN", "NA" |
TIN | string | Enter the nine-digit taxpayer identification number of the Recipient (SSN, ITIN, ATIN, or EIN). Size Range: 9-11 |
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 |
FirstNm | string | First Name of the Individual Size Range: ..20 |
MiddleNm | string | Middle Name of the Individual Size Range: ..20 |
LastNm | string | Last Name of the Individual Size Range: ..20 |
Suffix | string | Suffix of the IndividualAllowed values"Jr", "Sr", "I", "II", "III", "IV", "V", "VI", "VII" |
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: ..46 |
Address2 | string | Optional Recipient's suite or apartment Size Range: ..46 |
City | string | Recipient's city Size Range: ..50 |
State | string | Recipient's state code. Refer Static values. Size Range: 2 Allowed values"AL", "AK", "AZ", "AR", "CA", "CO", "CT", "DE", "DC", "FL", "GA", "HI", "ID", "IL", "IN", "IA", "KS", "KY", "LA", "ME", "MD", "MA", "MI", "MN", "MS", "MO", "MT", "NE", "NV", "NH", "NJ", "NM", "NY", "NC", "ND", "OH", "OK", "OR", "PA", "RI", "SC", "SD", "TN", "TX", "UT", "VT", "VA", "WA", "WV", "WI", "WY", "AS", "FM", "GU", "MH", "MP", "PW", "PR", "VI", "AA", "AE", "AP" |
ZipCd | string | Recipient's zip code Size Range: 5..10 |
ForeignAddress | object | If IsForeign is true, pass foreign address of the recipient |
Address1 | string | Recipient's foreign address (street address or post office box of that locality) Size Range: ..50 |
Address2 | string | Optional Recipient's suite or apartment Size Range: ..50 |
City | string | Recipient's city. Size Range: ..50 |
ProvinceOrStateNm | string | Recipient's Province or State Name. Size Range: ..50 |
Country | string | Recipient's country code. Refer Static values. Size Range: 2 Allowed values"AF", "AX", "AL", "AG", "AQ", "AN", "AO", "AV", "AY", "AC", "AR", "AM", "AA", "AT", "AS", "AU", "AJ", "BF", "BA", "FQ", "BG", "BB", "BO", "BE", "BH", "BN", "BD", "BT", "BL", "BK", "BC", "BV", "BR", "IO", "VI", "BX", "BU", "UV", "BM", "BY", "CB", "CM", "CA", "CV", "CJ", "CT", "CD", "CI", "CH", "KT", "IP", "CK", "CO", "CN", "CF", "CG", "CW", "CR", "CS", "IV", "HR", "CU", "UC", "CY", "EZ", "DA", "DX", "DJ", "DO", "DR", "TT", "EC", "EG", "ES", "EK", "ER", "EN", "ET", "FK", "FO", "FM", "FJ", "FI", "FR", "FP", "FS", "GB", "GA", "GG", "GM", "GH", "GI", "GR", "GL", "GJ", "GQ", "GT", "GK", "GV", "PU", "GY", "HA", "HM", "VT", "HO", "HK", "HQ", "HU", "IC", "IN", "ID", "IR", "IZ", "EI", "IS", "IT", "JM", "JN", "JA", "DQ", "JE", "JQ", "JO", "KZ", "KE", "KQ", "KR", "KN", "KS", "KV", "KU", "KG", "LA", "LG", "LE", "LT", "LI", "LY", "LS", "LH", "LU", "MC", "MK", "MA", "MI", "MY", "MV", "ML", "MT", "IM", "RM", "MR", "MP", "MX", "MQ", "MD", "MN", "MG", "MJ", "MH", "MO", "MZ", "WA", "NR", "BQ", "NP", "NL", "NC", "NZ", "NU", "NG", "NI", "NE", "NF", "CQ", "NO", "MU", "OC", "PK", "PS", "LQ", "PM", "PP", "PF", "PA", "PE", "RP", "PC", "PL", "PO", "RQ", "QA", "RO", "RS", "RW", "TB", "RN", "WS", "SM", "TP", "SA", "SG", "RI", "SE", "SL", "SN", "NN", "LO", "SI", "BP", "SO", "SF", "SX", "OD", "SP", "PG", "CE", "SH", "SC", "ST", "SB", "VC", "SU", "NS", "SV", "WZ", "SW", "SZ", "SY", "TW", "TI", "TZ", "TH", "TO", "TL", "TN", "TD", "TS", "TU", "TX", "TK", "TV", "UG", "UP", "AE", "UK", "UY", "UZ", "NH", "VE", "VM", "VQ", "WQ", "WF", "WI", "YM", "ZA", "ZI" |
PostalCd | string | Recipient's Postal Code Size Range: ..16 |
string | Optional Recipient's email address. Size Range: 0..100 Note : This email address cannot be the same for two different recipients under the same business. | |
Fax | string | Optional Recipient's Fax number. Size Range: 10 |
Phone | string | Optional Recipient's Phone Number. Size Range: 15 |
GFormData | object | Recipient's Form 1099-G information. |
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"2010","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 Note : This value should be less than 40% of the sum of boxes 5, 6, 7. |
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 |
Request JSON
- Sample 1
- Sample 2
Created a Form 1099-G return for the specific Business, including recipient and income information. Now, update the Recipient/Form Details with RecipientId and RecordId.
{
"SubmissionManifest": {
"SubmissionId": "b8da099b-71c6-43bd-9932-94044458a68e",
"TaxYear": "2021",
"IsFederalFiling": true,
"IsStateFiling": true,
"IsPostal": true,
"IsOnlineAccess": true,
"IsScheduleFiling": true,
"ScheduleFiling": {
"EfileDate": "12/25/2024"
}
},
"ReturnHeader": {
"Business": {
"BusinessId": "08631c17-564c-433d-a3ea-ff7f6f3ff1e6",
"BusinessNm": "Snowdaze LLC",
"FirstNm": null,
"MiddleNm": null,
"LastNm": null,
"Suffix": null,
"PayerRef": "Snow123",
"TradeNm": "Iceberg Icecreams",
"IsEIN": true,
"EINorSSN": "65-7369245",
"Email": "james@sample.com",
"ContactNm": null,
"Phone": "1234567890",
"PhoneExtn": "12345",
"Fax": "1234567890",
"BusinessType": "ESTE",
"SigningAuthority": null,
"KindOfEmployer": "FederalGovt",
"KindOfPayer": "REGULAR941",
"IsBusinessTerminated": false,
"IsForeign": false,
"USAddress": {
"Address1": "3576 AIRPORT WAY",
"Address2": "UNIT 9",
"City": "FAIRBANKS",
"State": "AK",
"ZipCd": "99709"
},
"ForeignAddress": null
}
},
"ReturnData": [
{
"SequenceId": "1",
"RecordId": "b33c2768-87d3-4954-a4db-61fa4b5cd883",
"IsPostal": true,
"IsOnlineAccess": true,
"Recipient": {
"RecipientId": "63ce1ce9-8eef-4342-9f4c-006542f8eb50",
"TINType": "EIN",
"TIN": "39-3817572",
"FirstPayeeNm": "Dairy Delights LLC",
"SecondPayeeNm": null,
"FirstNm": null,
"MiddleNm": null,
"LastNm": null,
"Suffix": null,
"IsForeign": true,
"USAddress": null,
"ForeignAddress": {
"Address1": "120 Bremner Blvd",
"Address2": "Suite 800",
"City": "Toronto",
"ProvinceOrStateNm": "Ontario",
"Country": "CA",
"PostalCd": "4168682600"
},
"Email": "shawn@sample.com",
"Fax": "6634567890",
"Phone": "9634567890"
},
"GFormData": {
"B1UnempComp": 7010.27,
"B2TaxRefunds": 97.00,
"B3TaxYearOfB2Amt": 2021,
"B4FedTaxWH": 70.23,
"B5RTAAPayments": 390.00,
"B6TaxableGrants": 230.00,
"B7AgriPayments": 340.00,
"B8IsTradeOrBizIncome": false,
"B9MarketGain": 435.00,
"Is2ndTINnot": false,
"AccountNum": "587879879879",
"States": null
}
}
]
}
Created a Form 1099-G return for the specific Business, including recipient and income information. Now, create a new Recipient/Form without RecipientId and RecordId.
{
"SubmissionManifest": {
"SubmissionId": "b8da099b-71c6-43bd-9932-94044458a68e",
"TaxYear": "2021",
"IsFederalFiling": true,
"IsStateFiling": true,
"IsPostal": true,
"IsOnlineAccess": true,
"IsScheduleFiling": true,
"ScheduleFiling": {
"EfileDate": "12/25/2024"
}
},
"ReturnHeader": {
"Business": {
"BusinessId": null,
"BusinessNm": "Snowdaze LLC",
"FirstNm": null,
"MiddleNm": null,
"LastNm": null,
"Suffix": null,
"PayerRef": "Snow123",
"TradeNm": "Iceberg Icecreams",
"IsEIN": true,
"EINorSSN": "65-7369245",
"Email": "james@sample.com",
"ContactNm": null,
"Phone": "1234567890",
"PhoneExtn": "12345",
"Fax": "1234567890",
"BusinessType": "ESTE",
"SigningAuthority": null,
"KindOfEmployer": "FederalGovt",
"KindOfPayer": "REGULAR941",
"IsBusinessTerminated": false,
"IsForeign": false,
"USAddress": {
"Address1": "3576 AIRPORT WAY",
"Address2": "UNIT 9",
"City": "FAIRBANKS",
"State": "AK",
"ZipCd": "99709"
},
"ForeignAddress": null
}
},
"ReturnData": [
{
"SequenceId": "1",
"RecordId": null,
"IsPostal": true,
"IsOnlineAccess": true,
"Recipient": {
"RecipientId": null,
"TINType": "EIN",
"TIN": "39-3817572",
"FirstPayeeNm": "Dairy Delights LLC",
"SecondPayeeNm": null,
"FirstNm": null,
"MiddleNm": null,
"LastNm": null,
"Suffix": null,
"IsForeign": true,
"USAddress": null,
"ForeignAddress": {
"Address1": "120 Bremner Blvd",
"Address2": "Suite 800",
"City": "Toronto",
"ProvinceOrStateNm": "Ontario",
"Country": "CA",
"PostalCd": "4168682600"
},
"Email": "shawn@sample.com",
"Fax": "6634567890",
"Phone": "9634567890"
},
"GFormData": {
"B1UnempComp": 7010.27,
"B2TaxRefunds": 97.00,
"B3TaxYearOfB2Amt": 2021,
"B4FedTaxWH": 70.23,
"B5RTAAPayments": 390.00,
"B6TaxableGrants": 230.00,
"B7AgriPayments": 340.00,
"B8IsTradeOrBizIncome": false,
"B9MarketGain": 435.00,
"Is2ndTINnot": false,
"AccountNum": "587879879879",
"States": null
}
}
]
}
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 the detailed information about the success status of Form 1099 Records |
SequenceId | string | A unique number given by an inbound application to identify failed records |
RecordId | Guid | Unique identifier of a record |
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. |
ErrorRecords | object[] | It will show the detailed information about the error status of Form 1099 Records. |
RecordId | Guid | Unique identifier of a record |
SequenceId | string | A unique number given by an inbound application to identify failed records |
RejectedBy | string | Returns the information of who rejected the return. |
Errors | object[] | Shows detailed error information |
Code | 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 |
Errors | object[] | Shows detailed error information |
Code | 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 |
Response JSON
- 200
- 300
- 400
Success Response - This is a sample response for successful API requests.
{
"StatusCode": 200,
"StatusName": "Ok",
"StatusMessage": "Successful API call",
"SubmissionId": "cea8be7c-1c1d-4bf7-ba68-509f3e07d1ef",
"BusinessId": "bfe7ee55-835c-4fe1-a2b7-1e7c3027598b",
"PayerRef": "Snow123",
"Form1099Type": "G",
"Form1099Records": {
"SuccessRecords": [
{
"SequenceId": "1",
"RecordId": "e1ba8410-2e95-4c9d-9838-615197377c79",
"RecipientId": "c34ac3c9-5f41-4dd5-887e-7fdc215eae90",
"AccountNum": "20123130000009000761",
"FederalReturn": {
"Status": "CREATED",
"StatusTs": "2024-06-13 01:32:31 -04:00",
"Info": null,
"Errors": null
},
"StateReturns": null,
"Postal": {
"Status": "NOTCREATED",
"StatusTs": null,
"Info": "Postal Alert cannot be opted for the return, when the recipient (or) business has foreign address"
},
"OnlineAccess": {
"Status": "CREATED",
"Email": "shawn@sample.com",
"Info": null
},
"ScheduleFiling": {
"ScheduledOn": null,
"Info": "This Service will be available soon"
}
}
],
"ErrorRecords": null
},
"Errors": null
}
Multi-status Response - You'll get the below response when multiple statuses are included.
{
"StatusCode": 300,
"StatusName": "MultiStatus",
"StatusMessage": "Multiple statuses are available for the request",
"SubmissionId": "b8da099b-71c6-43bd-9932-94044458a68e",
"BusinessId": "cb514f7f-073a-4742-8382-636766c1240f",
"PayerRef": "Snow1323",
"Form1099Type": "G",
"Form1099Records": {
"SuccessRecords": [
{
"SequenceId": "2",
"RecordId": "70130e8a-a7e8-4fbe-90ac-fb5886c629ea",
"RecipientId": "ac52566d-d78a-494f-b62a-8444523258d7",
"AccountNum": "20231520040564004590",
"FederalReturn": {
"Status": "CREATED",
"StatusTs": "2024-05-31 06:26:17 -04:00",
"Info": null,
"Errors": null
},
"StateReturns": null,
"Postal": {
"Status": "NOTCREATED",
"StatusTs": null,
"Info": "Postal Alert cannot be opted for the return, when the recipient (or) business address has foreign address"
},
"OnlineAccess": {
"Status": "CREATED",
"Email": "shawn@sample.com",
"Info": null
},
"ScheduleFiling": {
"ScheduledOn": null,
"Info": "This Service will be available soon"
}
}
],
"ErrorRecords": [
{
"SequenceId": "1",
"RecordId": null,
"Errors": [
{
"Id": "F02-100046",
"Name": "GFormData.B1UnempComp",
"Message": "Possible Duplicate. Another return has been created for the same recipient with the same amount."
}
]
}
]
},
"Errors": [
{
"Id": "F00-100155",
"Name": "Error Records",
"Message": "Some of the records are errored. Please read the Error Records for more details."
}
]
}
Bad Request Response - You'll get the below response when your API requests contain any validation errors.
{
"StatusCode": 400,
"StatusName": "BadRequest",
"StatusMessage": "Validation error has occurred",
"SubmissionId": "b8da099b-71c6-43bd-9932-94044458a68e",
"BusinessId": "cb514f7f-073a-4742-8382-636766c1240f",
"PayerRef": "Snow1323",
"Form1099Type": "G",
"Form1099Records": null,
"Errors": [
{
"Id": "F68-100053",
"Name": "ReturnData.SequenceId",
"Message": "Duplicate sequence id exist. The sequence Id [1] is repeated more than once."
}
]
}