Update
PUT Form1099GCorrection/Update
Request Body
Field | Type | Description |
---|---|---|
SubmissionManifest | object | SubmissionManifest provides brief information about a particular submission on the whole. It contains information like
|
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 Correction to be filed. Allowed values:"2023" |
IsFederalFiling | Boolean | This value must be set as True in order to have Form 1099 G Correction filed to the IRS. |
IsPostal | Boolean | If this value is set as True, the postal mailing service will be opted for all the recipients included in the submission.Once the returns are transmitted, the 1099 G correction form copies will be mailed to the recipient's address via USPS. Note: Postal Orders for Foreign Address will not be created. |
IsOnlineAccess | Boolean | If this value is set as True, the Online Access service will be enabled for all the recipients included in the submission.Once the returns are transmitted, an email with a link to the secure TaxBandits portal will be sent to the recipients. The recipients can then provide consent and download Form 1099 G Correction copies from the portal. The Online Access portal can be customized with the client logo. |
ReturnHeader | object | Contains information about the Business details. |
Business | object | Object to identify the Business Details. |
BusinessId | Guid | Optional Use the unique Business ID (Generated by TaxBandits), you received in the response of the Business CREATE Endpoint. If you do not have a Business ID, ignore the field. By giving the Business ID, you do not have to provide all the business information again. |
BusinessNm | string | Name of the business. Size Range: ..75 |
FirstNm | string | First Name of the Individual Size Range: ..20 |
MiddleNm | string | Middle Name of the Individual Size Range: ..20 |
LastNm | string | Last Name of the Individual Size Range: ..20 |
Suffix | string | Suffix of the IndividualAllowed values"Jr", "Sr", "I", "II", "III", "IV", "V", "VI", "VII" |
TradeNm | string | Optional Name under which the business operates. Size Range: ..75 |
IsEIN | Boolean | When true, identify that the business TIN is an EIN. |
EINorSSN | string | When IsEIN is true, use Employer Identification Number (EIN). When IsEIN is false, use Social Security Number (SSN) Size Range: 9-11 |
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 correction details. |
Manifest | object | Collects the Record id, Sequence Id and Correction Type information. |
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 |
PrevReportedRecordId | string | If you are correcting a 1099 G that was originally filed with TaxBandits, provide the Record ID of the original Form 1099 G here. The PrevReportedRecipient Object is not required if you provide the PrevReportedRecordID. |
CorrectionType | string | Provide the type of correction you are filing for the recipient. Allowed values :
|
IsPostal | Boolean | If this value is set as true, the Postal Mailing service will be opted for the recipient included in the record. Once the return is transmitted, the 1099 G correction copy will be mailed to the recipient's address via USPS. Postal Orders for Foreign Address will not be created. Note: To enable this, you must have set the IsPostal value as True under the submission. You can set this value as False for the other records for which you don’t want this service. |
IsOnlineAccess | Boolean | If this value is set as true, the Online Access service will be enabled for the recipient included in the record. Once the return is transmitted, an email with a link to the secure TaxBandits portal will be sent to the recipient. The recipient can then provide consent and download Form 1099 G correction copy from the portal. Note: To enable this, you must have set the IsOnlineAccess value as True under the submission. You can set this value as False for the other records for which you don’t want this service. |
PrevReportedRecipientData | object | Enter the Recipient information that was submitted in the Original Form 1099 G. The information is not required if you have provided the PrevReportedRecordId. |
RecipientId | Guid | OptionalAn unique ID generated by TaxBandits after the return is created and will be returned in the Response. You can use this id for your future reference to Update. |
TINType | string | Specify the TIN type of the recipient. Note: If the recipient doesn't have a TIN, enter the TIN type as 'NA' and input 'null' in the TIN field. Allowed values"SSN", "EIN", "ITIN", "ATIN", "NA" |
TIN | string | 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" |
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:"2023" |
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 1, 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 Note: If the account number on the return you file is the same as any previously filed return, TaxBandits will append 3 random numbers at the end of the account number. |
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
{
"SubmissionManifest": {
"TaxYear": "2023",
"IsFederalFiling": true,
"IsStateFiling": true,
"IsPostal": true,
"IsOnlineAccess": true
},
"ReturnHeader": {
"Business": {
"BusinessId": "e184841c-fd2a-42b4-855e-50efcfd34614",
"PayerRef": "AB101",
"BusinessNm": "Snowdaze LLC",
"TradeNm": "Tasty ICC",
"FirstNm": null,
"MiddleNm": null,
"LastNm": null,
"Suffix": null,
"IsEIN": true,
"EINorSSN": "42-3427458",
"Email": "sample@bodeem.com",
"ContactNm": "John",
"Phone": "1234567890",
"PhoneExtn": "12345",
"Fax": "1234567890",
"BusinessType": "ESTE",
"SigningAuthority": {
"Name": "John",
"Phone": "1234567890",
"BusinessMemberType": "ADMINISTRATOR"
},
"KindOfEmployer": "FederalGovt",
"KindOfPayer": "REGULAR941",
"IsBusinessTerminated": true,
"IsForeign": false,
"USAddress": {
"Address1": "1751 Kinsey Rd",
"Address2": "Main St",
"City": "Dothan",
"State": "AL",
"ZipCd": "36303"
},
"ForeignAddress": {
"Address1": null,
"Address2": null,
"City": null,
"ProvinceOrStateNm": null,
"Country": null,
"PostalCd": null
}
}
},
"ReturnData": [
{
"Manifest": {
"SequenceId": "001",
"PrevReportedRecordId": "fa46ee66-f622-472a-b2d7-94da4d316377",
"CorrectionType": "RECIPIENT_AMOUNT",
"IsPostal": true,
"IsOnlineAccess": true
},
"PrevReportedRecipientData": {
"RecipientId": "b6fc9326-4029-40a1-a516-572218f500ef",
"TINType": "EIN",
"TIN": "414-24-9606",
"FirstPayeeNm": "Mark",
"SecondPayeeNm": "Davis",
"IsForeign": false,
"USAddress": {
"Address1": "1751 Kinsey Rd",
"Address2": "Main St",
"City": "Dothan",
"State": "AL",
"ZipCd": "36303"
},
"ForeignAddress": {
"Address1": null,
"Address2": null,
"City": null,
"ProvinceOrStateNm": null,
"Country": null,
"PostalCd": null
},
"Email": "sample@bodeem.com",
"Fax": "9225538719",
"Phone": "9225538719"
},
"CorrectedRecipientData": {
"TINType": "EIN",
"TIN": "414-24-9607",
"FirstPayeeNm": "Stephen",
"SecondPayeeNm": "Hawkeye",
"FirstNm": null,
"MiddleNm": null,
"LastNm": null,
"Suffix": null,
"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": "sample@bodeem.com",
"Fax": "9225538719",
"Phone": "9225538719"
},
"MISCFormData": {
"B1Rents": 1400.54,
"B2Royalties": 7000.27,
"B3OtherIncome": 1000.86,
"B4FedIncomeTaxWH": 30.23,
"B5FishingBoatProceeds": 0,
"B6MedHealthcarePymts": 0,
"B7IsDirectSale": false,
"B8SubstitutePymts": 0,
"B9CropInsurance": 0,
"B10GrossProceeds": 0,
"B11FishPurForResale": 0,
"B12Sec409ADeferrals": 0,
"B13IsFATCA": true,
"B14EPP": 52.63,
"B15NonQualDefComp": 12.78,
"AccountNum": "587879879879",
"Is2ndTINnot": true,
"States": [
{
"StateCd": "PA",
"StateWH": 15.56,
"StateIdNum": "99999999",
"StateIncome": 16.36
},
{
"StateCd": "AZ",
"StateWH": 17.45,
"StateIdNum": "99-9999999",
"StateIncome": 18.78
}
]
}
}
]
}
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. |
Form1099Type | string | Denotes the type of 1099 form. |
Form1099Records | object | Pulls Form 1099 G correction records with Success and Error statuses |
SuccessRecords | object[] | It will show the detailed information about the success status of Form 1099 G correction 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. |
PrevReportedRecordId | string | Record ID of the original Form 1099 G which is given while creating Form 1099 G correction. |
RecordId | Guid | An unique identifier generated by TaxBandits when a 1099 G correction return is created. You can use this id for your future reference to Update. |
RecipientId | Guid | An unique identifier generated by TaxBandits for a Recipient when a 1099 G correction 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. |
Errors | object[] | Shows error information of federal returns of Form 1099 G correction. |
StateReturns | object[] | Returns collection of state returns information |
Postal | object | Returns the status and StatusTs of postal mailing service for Form 1099 G correction. |
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 correction return. |
string | Email address for whom the online access to be given. | |
Info | string | Information about the online access service. |
ErrorRecords | object[] | It will show the detailed information about the error status of Form 1099 G correction 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 |
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": "15c90b05-8b65-4cff-bd9d-0a6d199c5c59",
"BusinessId": "6aa7d544-c6ed-45df-9d6d-f7d64e8289fc",
"Form1099Type": "GCorrection",
"Form1099Records": {
"SuccessRecords": [
{
"SequenceId": "001",
"PrevReportedRecordId": "e7c7a8e5-ce79-4545-aeb8-b600b6d16af6",
"RecordId": "d459c281-82b6-40bd-abec-7b83b01bcc1d",
"RecipientId": "d176ff68-7ac8-40bb-ad28-616e2b60b279",
"FederalReturn": {
"Status": "CREATED",
"StatusTs": "2024-01-12 04:38:17 -05:00",
"Info": null,
"Errors": null
},
"StateReturns": null,
"Postal": {
"Status": "CREATED",
"StatusTs": "2024-01-12 04:38:17 -05:00",
"Info": null
},
"OnlineAccess": {
"Status": "NA",
"Email": 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": "45d1a2c2-bf72-4616-ac90-aa919b373637",
"BusinessId": "a9814756-758f-48ad-b039-c6d3bcc49866",
"Form1099Type": "GCorrection",
"Form1099Records": {
"SuccessRecords": [
{
"SequenceId": "001",
"PrevReportedRecordId": "dc47347e-6d21-4107-86f7-50bec552a565",
"RecordId": "4b5e78fe-5dce-420d-a5c6-f1926aa1ec89",
"RecipientId": "292bc96c-218c-49f7-aaaf-9c7a92f5d933",
"FederalReturn": {
"Status": "CREATED",
"StatusTs": "2024-07-01 05:23:03 -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": "NA",
"Email": null,
"Info": "This Service will be available soon"
}
}
],
"ErrorRecords": [
{
"SequenceId": "2",
"RecordId": null,
"Errors": [
{
"Id": "F68-100084",
"Name": "ReturnData.Manifest.PrevReportedRecordId",
"Message": "Correction return already exists for the given PrevReportedRecordId [e981a0ea-3f85-4102-afee-7db4c0ead9fe]"
}
]
}
]
},
"Errors": [
{
"Id": "F00-100155",
"Name": "Error Records",
"Message": "Some of the records are errored. Please read the Error Records for more details."
}
]
}
Bad Request Response - You'll get the below response when your API requests contain any validation errors.
{
"StatusCode": 400,
"StatusName": "BadRequest",
"StatusMessage": "Validation error has occurred",
"SubmissionId": null,
"BusinessId": null,
"Form1099Type": "GCorrection",
"Form1099Records": {
"SuccessRecords": null,
"ErrorRecords": [
{
"SequenceId": "001",
"RecordId": null,
"Errors": [
{
"Id": "F68-100084",
"Name": "ReturnData.Manifest.PrevReportedRecordId",
"Message": "Correction return already exists for the given PrevReportedRecordId [dc47347e-6d21-4107-86f7-50bec552a565]"
}
]
}
]
},
"Errors": null
}