Extend your software with TaxBandits IRS E-file API Integration

Skip to main content
Version: 1.6.1

Get

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

GET Form1099S/Get

Request Body

FieldTypeDescription
SubmissionIdGuidA 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.
RecordIdsGuid[]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.

Response Body

FieldTypeDescription
StatusCodenumberReturns the HTTP status codes like 200,300 etc.
StatusNamestringName of the status code
StatusMessagestringDetailed status message
Form1099RecordsobjectContains information about Form 1099 S returns.
SubmissionManifestobjectSubmissionManifest 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.
    SubmissionIdGuidUnique identifier created by TaxBandits for each submission. Not required when you are creating a return.
    TaxYearstringTax year of Form 1099 S to be filed.
Allowed values: "2021"
    IsFederalFilingBooleanFederal Filing for the return will be enabled when the value is True. The Form 1099-S will be sent directly to the IRS.
    IsStateFilingBooleanState 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.
    IsPostalBooleanPostal Order will be created when the value is set as True. Once the return is Transmitted, Form 1099-S Recipient copies will be postal mailed to the recipient's address via USPS.
Note: Postal Orders for Foreign Address will not be created.
    IsOnlineAccessBooleanOnline 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-S Recipient copies from the portal.
    IsScheduleFilingBooleanWhen true, schedule filing services will be provided for Form 1099 S returns under this submission.
    ScheduleFilingobjectContains preferred date to submit the returns to the IRS. Required only when "IsScheduleFiling" is True.
        EfileDatestringDate of Schedule Filing. Enter the date in the format: MM/DD/YYYY or MM-DD-YYYY Example: 10/20/2021 or 10-20-2021
ReturnHeaderobjectContains information about the Business details.
    BusinessobjectObject to identify the Business Details.
        BusinessIdGuidReturns the unique Business ID for the Business. It can be used in future to refer the same business.
        PayerRefstringAn 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
        BusinessNmstringName of the business
Size Range: ..80
        TradeNmstringOptional Name under which the business operates
Size Range: ..80
        IsEINBooleanWhen true, identifies the business with an EIN.
        EINorSSNstringReturns the Employer Identification Number of Business
Size Range: 9
        EmailstringOptional Email address of the Business
Size Range: ..40
        ContactNmstringOptional Name of the person who can be contacted by the IRS
Size Range: ..27
        PhonestringOptional Phone number of the business
Size Range: 10
        PhoneExtnstringOptional Extension of the business phone number
Size Range: ..5
        FaxstringOptional Fax number of the Business
Size Range: 10
        BusinessTypestringOptional Type of business. Optional for W-2/1099 and mandatory for 94X series
Size Range: ..4
Allowed values: "ESTE", "PART", "CORP", "EORG", "SPRO"
        SigningAuthorityobjectOptional Details of the person who is authorized to sign the return
            NamestringOptional Name of the signing authority
Size Range: ..35
            PhonestringOptional Phone number of the signing authority
Size Range: 10
            BusinessMemberTypestringOptional 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"
        KindOfEmployerstringOptional Identifies the kind of employer. Mandatory for W-2 and optional for Form 1099-S and 94X series
Allowed values: "FEDERALGOVT", "STATEORLOCAL501C", "NONGOVT501C", "STATEORLOCALNON501C", "NONEAPPLY"
        KindOfPayerstringOptional Identifies the kind of payer. This field is mandatory in W-2 and optional in Form 1099-S and 94X series
Allowed values: "REGULAR941", "REGULAR944", "AGRICULTURAL943", "HOUSEHOLD", "MILITARY", "MEDICAREQUALGOVEM", "RAILROADFORMCT1"
        IsBusinessTerminatedBooleanWhen true, identifies the business as terminated.
        IsForeignBooleanWhen true, identifies the business address with a foreign address.
        USAddressobjectIf IsForeign is false, pass US address of the business
            Address1stringEmployer/Payer's US address (street address or post office box of that locality)
Size Range: ..35
            Address2stringOptional Employer/Payer's suite or apartment
Size Range: ..35
            CitystringEmployer/Payer's city
Size Range: ..27
            StatestringEmployer/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"
            ZipCdstringEmployer/Payer's zip code
Size Range: 5,9
        ForeignAddressobjectIf IsForeign is true, pass foreign address of the business
            Address1stringEmployer/Payer's foreign address (street address or post office box of that locality)
Size Range: ..35
            Address2stringOptional Employer/Payer's suite or apartment
Size Range: ..35
            CitystringEmployer/Payer's city
Size Range: ..27
            ProvinceOrStateNmstringEmployer/Payer's province or state name
Size Range: ..30
            CountrystringEmployer/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"
            PostalCdstringEmployer/Payer's postal code
Size Range: 9
ReturnDataobject[]Contains information about the recipient details and Form 1099 S details.
    RecordIdGuidUnique identifier of a record. Not required when you are creating a return.
    SequenceIdstringAn 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.
    RecipientobjectObject to identify the recipient details.
        RecipientIdGuidAn 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.
        TINTypestringSpecify the TIN type of the recipient.
Allowed values: "SSN", "EIN", "ITIN", "ATIN", "N/A"
        TINstringEnter the nine-digit taxpayer identification number of the Recipient (SSN, ITIN, ATIN, or EIN).
Size Range: 9
        FirstPayeeNmstringEnter 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.
        SecondPayeeNmstringOptional 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.
        IsForeignBooleanWhen true, identifies the recipient address with a foreign address.
        USAddressobjectIf IsForeign is false, pass US address of the recipient
            Address1stringRecipient's US address (street address or post office box of that locality)
Size Range: ..35
            Address2stringOptional Recipient's suite or apartment
Size Range: ..35
            CitystringRecipient's city
Size Range: ..27
            StatestringRecipient'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"
            ZipCdstringRecipient's zip code.
Size Range: 5,9
        ForeignAddressobjectIf IsForeign is true, pass foreign address of the recipient
            Address1stringRecipient's foreign address (street address or post office box of that locality)
Size Range: ..35
            Address2stringOptional Recipient's suite or apartment
Size Range: ..35
            CitystringRecipient's city.
Size Range: ..27
            ProvinceOrStateNmstringRecipient's Province or State Name.
Size Range: ..30
            CountrystringRecipient'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"
            PostalCdstringRecipient's Postal Code.
Size Range: 9
        EmailstringOptional Recipient's email address.
Size Range: 0..40
        FaxstringOptional Recipient's Fax number.
Size Range: 10
        PhonestringOptional Recipient's Phone Number.
Size Range: 10
    1099SFormDataobjectObject to create 1099-S.
        B1DateOfClosingnumberDate of Closing - Get the date in this format 'YYYYMMDD'.
Size Range: 8
        B2GrossProceedsnumberGross Proceeds - Gets the gross proceeds paid to the recipient.
Size Range: 0-9999999999.99
        B3AddressOrLegalDescrnumberAddress or Legal Description - Get the address of the property transferred.
Size Range: 39
        B4IsPropertyOrServiceRcvdBooleanWhen True, transferor received or will receive property or services as part of the consideration for the property transferred.
        B5IsTransferorForeignBooleanWhen True, transferor is a foreign person.
        B6BuyersTaxnumberBuyer’s part of real estate tax - Get the Tax amount.
Size Range: 0-9999999999.99
        AccountNumstringAccount number of Payer having multiple accounts for a recipient for whom more than one Form 1099-S is filed.
Size Range: 4..20
Errorsobject[]Shows detailed error information
    IdstringReturns the validation error Id
    NamestringName of the validation error
    MessagestringDescription of the validation error

Request JSON

Form1099S/Get?SubmissionId=94419089-f9fe-4390-b622-ee06f7682754&RecordIds=aabf8859-c07a-4ea1-bdc5-0088cf037f03

Response JSON

{   "StatusCode": 200,   "StatusName": "Ok",   "StatusMessage": "Successful API call",   "Form1099Records": {       "SubmissionManifest": {           "SubmissionId": "94419089-f9fe-4390-b622-ee06f7682754",           "TaxYear": "2021",           "IsFederalFiling": true,           "IsPostal": true,           "IsOnlineAccess": true,           "IsScheduleFiling": true,           "ScheduleFiling": {               "EfileDate": "11/29/2021"           }       },       "ReturnHeader": {           "Business": {               "BusinessId": "7eba6458-72f3-4aa8-9d1e-bd7c0d36fa50",               "PayerRef": "9894D",               "BusinessNm": "Chris LLC",               "TradeNm": "Chris Corporate Services",               "IsEIN": false,               "EINorSSN": "092-11-5111",               "Email": "Chrisscott@gmail.com",               "ContactNm": "Chris O Reins",               "Phone": "(123) 456-7890",               "PhoneExtn": "12345",               "Fax": null,               "BusinessType": "ESTE",               "SigningAuthority": {                   "Name": "Evans",                   "Phone": "(123) 457-8960",                   "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,               "IsGovernmentalUnit": false           }       },       "ReturnData": [           {               "RecordId": "aabf8859-c07a-4ea1-bdc5-0088cf037f03",               "SequenceId": "001",               "Recipient": {                   "RecipientId": "301ea317-b0b8-4018-b0b8-2832473bf737",                   "TINType": "SSN",                   "TIN": "222-21-4511",                   "FirstPayeeNm": "Steve",                   "SecondPayeeNm": "Rogers",                   "IsForeign": false,                   "USAddress": {                       "Address1": "1751 Kinsey Rd",                       "Address2": "Main St",                       "City": "Dothan",                       "State": "AL",                       "ZipCd": "36303"                   },                   "ForeignAddress": null,                   "Email": "john@gmail.com",                   "Fax": "(123) 456-7890",                   "Phone": "(123) 456-7890"               },               "SFormData": {                   "B1DateOfClosing": "12/12/2021",                   "B2GrossProceeds": 100.00,                   "B3AddressOrLegalDescr": "1751 Kinsey Rd",                   "B4IsPropertyOrServiceRcvd": false,                   "B5IsTransferorForeign": true,                   "B6BuyersTax": 10.00,                   "AccountNum": "125555"               }           }       ]   },   "Errors": null}