Get
Retrieves the Form 1099-S return information based on the Submission Id and RecordIds given in the request.
GET Form1099S/Get
Request Params
Field | Type | Description |
---|---|---|
SubmissionId | Guid | A unique identifier generated by TaxBandits when a 1099-S return is created. Mention the Form 1099-S return's Submission Id that you want to get. |
RecordIds | Guid[] | A unique identifier generated by TaxBandits when a 1099-S return is created. Mention the Form 1099-S return's Record Id that you want to get. |
Request Params
"Form1099S/Get?SubmissionId=4c31d380-2e2a-4d33-b3c6-bdf94eb3b0cd&RecordIds=3bf3cad7-5fd5-4918-8536-ed9f51da3336"
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-S 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-S to be filed. Allowed values: "2022","2023","2024" |
IRSFilingType | string | Specify the platform on which you want to file the 1099 return with the IRS:
Allowed values"FIRE","IRIS" |
IsFederalFiling | Boolean | Federal Filing for the return will be enabled when the value is True. The Form 1099-S will be sent directly to the IRS. |
IsStateFiling | Boolean | State Filing for the return will be enabled when the value is True. Form 1099-S 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 | 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-S 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-S copies from the portal. |
IsScheduleFiling | Boolean | When true, schedule filing services will be provided for Form 1099-S 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/2024 or 10-20-2024 |
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: ..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, identifies the business with an EIN. |
EINorSSN | string | Returns the Employer Identification Number of Business Size Range: 9 |
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", "TAX MATTERPARTNER", "PRESIDENT", "VICEPRESIDENT", "CORPORATETREASURER", "TREASURER", "ASSISTANTTREASURER", "CHIEFACCOUNTINGOFFICER", "CHIEFEX ECUTIVEOFFICER", "CHIEFFINANCIALOFFICER", "TAXOFFICER", "CHIEFOPERATINGOFFICER", "CORPORATEOFFICER", "EXECUTIVEDIRECTOR", "DIRECTOR", "CH AIRMAN", "EXECUTIVEADMINISTRATOR", "RECEIVER", "PASTOR", "ASSISTANTTORELIGIOUSLEADER", "REVEREND", "PRIEST", "MINISTER", "RABBI", "LEADEROF RELIGIOUSORGANIZATION", "SECRETARY", "DIRECTOROFTAXATION", "DIRECTOROFPERSONNEL", "ADMINISTRATOR", "EXECUTOR", "TRUSTEE", "FIDUCIARY", "OW NER", "SOLEPROPRIETOR", "MEMBER", "SOLEMEMBER" |
KindOfEmployer | string | Optional Identifies the kind of employer. Mandatory for W-2 and optional for Form 1099-S 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-S 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-S details. |
RecordId | Guid | Unique identifier of a record. Not required when you are creating a return. |
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-S 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-S 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. |
IsForced | Boolean | When TRUE, TaxBandits does not verify for duplicates and will create a new return for the recipient, even it comprises the same amounts as in previously filed returns. For more information on duplicate handling for Form 1099s, please click here. Note: If there are multiple returns filed for the recipient with the same account number, TaxBandits will append 3 random numbers at the end of the account number. |
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-S 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 |
PayeeRef | string | A unique identifier for each payee completing their information. |
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. |
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, identifies the recipient address with a foreign address. |
USAddress | object | If IsForeign is false, pass US address of the recipient |
Address1 | string | Recipient's US address (street address or post office box of that locality) Size Range: ..46 |
Address2 | string | Optional Recipient's suite or apartment Size Range: ..46 |
City | string | Recipient's city Size Range: ..50 |
State | string | Recipient's state code. Refer Static values. Size Range: 2 Allowed values"AL", "AK", "AZ", "AR", "CA", "CO", "CT", "DE", "DC", "FL", "GA", "HI", "ID", "IL", "IN", "IA", "KS", "KY", "LA", "ME", "MD", "MA", "MI", "MN", "MS", "MO", "MT", "NE", "NV", "NH", "NJ", "NM", "NY", "NC", "ND", "OH", "OK", "OR", "PA", "RI", "SC", "SD", "TN", "TX", "UT", "VT", "VA", "WA", "WV", "WI", "WY", "AS", "FM", "GU", "MH", "MP", "PW", "PR", "VI", "AA", "AE", "AP" |
ZipCd | string | Recipient's zip code Size Range: 5..10 |
ForeignAddress | object | If IsForeign is true, pass foreign address of the recipient |
Address1 | string | Recipient's foreign address (street address or post office box of that locality) Size Range: ..50 |
Address2 | string | Optional Recipient's suite or apartment Size Range: ..50 |
City | string | Recipient's city. Size Range: ..50 |
ProvinceOrStateNm | string | Recipient's Province or State Name. Size Range: ..50 |
Country | string | Recipient's country code. Refer Static values. Size Range: 2 Allowed values"AF", "AX", "AL", "AG", "AQ", "AN", "AO", "AV", "AY", "AC", "AR", "AM", "AA", "AT", "AS", "AU", "AJ", "BF", "BA", "FQ", "BG", "BB", "BO", "BE", "BH", "BN", "BD", "BT", "BL", "BK", "BC", "BV", "BR", "IO", "VI", "BX", "BU", "UV", "BM", "BY", "CB", "CM", "CA", "CV", "CJ", "CT", "CD", "CI", "CH", "KT", "IP", "CK", "CO", "CN", "CF", "CG", "CW", "CR", "CS", "IV", "HR", "CU", "UC", "CY", "EZ", "DA", "DX", "DJ", "DO", "DR", "TT", "EC", "EG", "ES", "EK", "ER", "EN", "ET", "FK", "FO", "FM", "FJ", "FI", "FR", "FP", "FS", "GB", "GA", "GG", "GM", "GH", "GI", "GR", "GL", "GJ", "GQ", "GT", "GK", "GV", "PU", "GY", "HA", "HM", "VT", "HO", "HK", "HQ", "HU", "IC", "IN", "ID", "IR", "IZ", "EI", "IS", "IT", "JM", "JN", "JA", "DQ", "JE", "JQ", "JO", "KZ", "KE", "KQ", "KR", "KN", "KS", "KV", "KU", "KG", "LA", "LG", "LE", "LT", "LI", "LY", "LS", "LH", "LU", "MC", "MK", "MA", "MI", "MY", "MV", "ML", "MT", "IM", "RM", "MR", "MP", "MX", "MQ", "MD", "MN", "MG", "MJ", "MH", "MO", "MZ", "WA", "NR", "BQ", "NP", "NL", "NC", "NZ", "NU", "NG", "NI", "NE", "NF", "CQ", "NO", "MU", "OC", "PK", "PS", "LQ", "PM", "PP", "PF", "PA", "PE", "RP", "PC", "PL", "PO", "RQ", "QA", "RO", "RS", "RW", "TB", "RN", "WS", "SM", "TP", "SA", "SG", "RI", "SE", "SL", "SN", "NN", "LO", "SI", "BP", "SO", "SF", "SX", "OD", "SP", "PG", "CE", "SH", "SC", "ST", "SB", "VC", "SU", "NS", "SV", "WZ", "SW", "SZ", "SY", "TW", "TI", "TZ", "TH", "TO", "TL", "TN", "TD", "TS", "TU", "TX", "TK", "TV", "UG", "UP", "AE", "UK", "UY", "UZ", "NH", "VE", "VM", "VQ", "WQ", "WF", "WI", "YM", "ZA", "ZI" |
PostalCd | string | Recipient's Postal Code Size Range: ..16 |
string | Optional Recipient's email address. Size Range: 0..100 | |
Fax | string | Optional Recipient's Fax number. Size Range: 10 |
Phone | string | Optional Recipient's Phone Number. Size Range: 10 |
SFormData | object | Recipient's Form 1099-S information. |
B1DateOfClosing | string | Date of Closing - Get the date in this format 'YYYYMMDD'. Size Range: 8 |
B2GrossProceeds | number | Gross Proceeds - Gets the gross proceeds paid to the recipient. Size Range: 0-9999999999.99 |
B3AddressOrLegalDescr | string | Address or Legal Description - Get the address of the property transferred. Size Range: 39 |
B4IsPropertyOrServiceRcvd | Boolean | When True, transferor received or will receive property or services as part of the consideration for the property transferred. |
B5IsTransferorForeign | Boolean | When True, transferor is a foreign person. |
B6BuyersTax | number | Buyer’s part of real estate tax - Get the Tax amount. Size Range: 0-9999999999.99 |
AccountNum | string | OptionalAccount number of Payer having multiple accounts for a recipient for whom more than one Form 1099-S 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. |
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
- 404
Success Response - This is a sample response for successful API requests.
{
"StatusCode": 200,
"StatusName": "Ok",
"StatusMessage": "Successful API call",
"Form1099Records": {
"SubmissionManifest": {
"SubmissionId": "234d1f53-292a-4a75-8baa-90d6777561fb",
"TaxYear": "2024",
"IRSFilingType":"IRIS",
"IsFederalFiling": true,
"IsStateFiling": true,
"IsPostal": true,
"IsOnlineAccess": true,
"IsScheduleFiling": false,
"ScheduleFiling": null
},
"ReturnHeader": {
"Business": {
"BusinessId": "7918e9ea-d936-41d1-8a88-12f951eccf5e",
"PayerRef": null,
"BusinessNm": "Snowdaze LLC",
"FirstNm": null,
"MiddleNm": null,
"LastNm": null,
"Suffix": null,
"TradeNm": "Iceberg Icecreams",
"IsEIN": true,
"EINorSSN": "66-2245105",
"Email": "chandler@sample.com",
"ContactNm": "Chandler White",
"Phone": "(983) 457-8960",
"PhoneExtn": "12345",
"Fax": null,
"BusinessType": "ESTE",
"SigningAuthority": {
"Name": "Chandler White",
"Phone": "(983) 457-8960",
"BusinessMemberType": "ADMINISTRATOR"
},
"KindOfEmployer": "FEDERALGOVT",
"KindOfPayer": "REGULAR941",
"IsBusinessTerminated": true,
"IsForeign": false,
"USAddress": {
"Address1": "1605 Park Avenue",
"Address2": "Louis St",
"City": "Seattle",
"State": "WA",
"ZipCd": "98944"
},
"ForeignAddress": null,
"ACADetails": null
}
},
"ReturnData": [
{
"RecordId": "faa221ea-7a7e-4f87-9b85-8f32d8338f96",
"SequenceId": "001",
"IsPostal": true,
"IsOnlineAccess": true,
"IsForced": true,
"Recipient": {
"RecipientId": "946bc7bc-e3e6-4935-887f-83101355100f",
"TINType": "EIN",
"TIN": "62-2214512",
"PayeeRef": "Payee001",
"FirstPayeeNm": "Dairy Delights LLC",
"SecondPayeeNm": "Coco Milk",
"FirstNm": null,
"LastNm": null,
"MiddleNm": null,
"Suffix": null,
"IsForeign": true,
"USAddress": null,
"ForeignAddress": {
"Address1": "120 Bremner Blvd",
"Address2": "Suite 800",
"City": "Toronto",
"ProvinceOrStateNm": "Ontario",
"Country": "CA",
"PostalCd": "4168682600"
},
"Email": "dairy@sample.com",
"Fax": "(223) 456-7890",
"Phone": "(963) 456-7890"
},
"SFormData": {
"B1DateOfClosing": "12/12/2023",
"B2GrossProceeds": 100.00,
"B3AddressOrLegalDescr": "18parkAvenue,KinseyRd,Texas,USA,59102",
"B4IsPropertyOrServiceRcvd": false,
"B5IsTransferorForeign": true,
"B6BuyersTax": 10.00,
"AccountNum": "125555605"
}
}
]
},
"Errors": null
}
Not Found Response - You'll get the below response if your API request contains a record that's not found in our database.
{
"StatusCode": 404,
"StatusName": "NotFound",
"StatusMessage": "The resource you have specified cannot be found",
"Form1099Records": null,
"Errors": [
{
"Id": "F00-100146",
"Name": "Submission Id",
"Message": "Submission Id is invalid"
}
]
}