GetbyRecordIds

This endpoint can be used to get the information from the 1098 Form created against the particular record. You will be able to pull the data from multiple records created under different submissions.

The response will include the Business information, Recipient details, and 1098 Form data.

POST Form1098/GetbyRecordIds 

Request Body

Field	Type	Description
RecordIds	object[]	Contains the object of RecordId
RecordId	Guid	The unique identifier of the record. Provide the RecordId for which you need to obtain the information

Request Json

{
   "RecordIds": [
       {
           "RecordId": "488b1c7e-d244-4d6a-8491-65ae2209a99f"
       }
   ]
}

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
Form1098Records	object	Contains information about Form 1098 returns.
SubmissionManifest	object	SubmissionManifest provides brief information about a particular submission on the whole. It contains information like Submission ID Tax Year IsPostal IsFederalFiling 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 1098 to be filed.
IRSFilingType	string	Specify the platform on which you want to file the 1098 return with the IRS: FIRE: Traditional platform,IRS will take 2 to 4 days to provide the accepted or rejected status. IRIS: The IRS's new platform for 1098 returns,IRS will provide the accepted or rejected status within 6hrs. Click here for more information about IRIS system. If no value is specified,Taxbandits will default to "FIRE".
IsPostal	Boolean	Postal Order will be created when the value is set as True. Once the return is Transmitted, Form 1098 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 1098 Recipient copies from the portal.
IsScheduleFiling	Boolean	When true, schedule filing services will be provided for Form 1098 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.
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	Unique identifier of the payer.
BusinessNm	string	Name of the business.
FirstNm	string	First Name of the Individual.
MiddleNm	string	Middle Name of the Individual.
LastNm	string	Last Name of the Individual.
Suffix	string	Suffix of the Individual.
TradeNm	string	Optional Name under which the business operates.
IsEIN	Boolean	When true, identifies the business with an EIN.
EINorSSN	string	Returns the Employer Identification Number of Business.
Email	string	Optional Email address of the Business.
ContactNm	string	Optional Name of the person who can be contacted by the IRS.
Phone	string	Optional Phone number of the business.
PhoneExtn	string	Optional Extension of the business phone number.
Fax	string	Optional Fax number of the Business.
BusinessType	string	Optional Type of business. Optional for w-2/1098 and mandatory for 94X series.
SigningAuthority	object	Optional Details of the person who is authorized to sign the return
Name	string	Optional Name of the signing authority.
Phone	string	Optional Phone number of the signing authority.
BusinessMemberType	string	Optional Business title of the signing authority.
KindOfEmployer	string	Optional Identifies the kind of employer. Mandatory for W-2 and optional for 1098.
KindOfPayer	string	Optional Identifies the kind of payer. This field is mandatory in W-2 and optional in 1098.
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).
Address2	string	Optional Employer/Payer's suite or apartment.
City	string	Employer/Payer's city.
State	string	Employer/Payer's state code.
ZipCd	string	Employer/Payer's zip code.
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).
Address2	string	Optional Employer/Payer's suite or apartment.
City	string	Employer/Payer's city.
ProvinceOrStateNm	string	Employer/Payer's province or state name.
Country	string	Employer/Payer's country.
PostalCd	string	Employer/Payer's postal code .
ReturnData	object[]	Contains information about the recipient details and Form 1098 details.
RecordId	string	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 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.
TIN	string	Nine-digit taxpayer identification number of the Recipient (SSN, ITIN, ATIN, or EIN).
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.
MiddleNm	string	Middle Name of the Individual.
LastNm	string	Last Name of the Individual.
Suffix	string	Suffix of the Individual.
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).
Address2	string	Optional Recipient's suite or apartment.
City	string	Recipient's city.
State	string	Recipient's state code.
ZipCd	string	Recipient's zip code.
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).
Address2	string	Optional Recipient's suite or apartment.
City	string	Recipient's city.
ProvinceOrStateNm	string	Recipient's Province or State Name.
Country	string	Recipient's country code.
PostalCd	string	Recipient's Postal Code.
Email	string	Optional Recipient's email address.
Fax	string	Optional Recipient's Fax number.
Phone	string	Optional Recipient's Phone Number.
Form1098Data	object	Recipient's Form 1098 information.
B1IntRec	number	Gets the Mortgage Interest Received from recipient .
B2OutPrin	number	Gets the Outstanding Mortgage Principal.
B3OrgDate	string	Gets the Date of the origination of the mortgage
B4RfdPd	number	Optional Gets the Total refund or credit of a prior year(s) overpayment of interest.
B5MIP	number	OptionalGets the Total Mortgage Insurance Premiums paid by the recipient.
B6PtsPd	number	OptionalGets the Points paid on the purchase of the recipient's principal residence.
B7PropAddSameAsRec	Boolean	When true, identifies that the address of the property securing the mortgage is the same as the recipient's mailing address. When false, provide the address or Description of the Property Securing Mortgage in B8PropDescr.
B8PropDescr	object	When true, identifies that the address of the property securing the mortgage is the same as the recipient's mailing address. When false, provide the address or Description of the Property Securing Mortgage in B8PropDescr.
Descr	string	Description of the property securing the mortgage.
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	US address (street address or post office box of that locality).
Address2	string	OptionalMortgage property's suite or apartment.
City	string	Mortgage property's city.
State	string	Mortgage property's state code.
ZipCd	string	Mortgage property's zip code.
ForeignAddress	object	If IsForeign is true, pass foreign address of the Mortgage property
Address1	string	Mortgage property's foreign address (street address or post office box of that locality).
Address2	string	Optional Mortgage property's suite or apartment.
City	string	Mortgage property's city.
ProvinceOrStateNm	string	Mortgage property's province or state name.
Country	string	Mortgage property's country.
PostalCd	string	Mortgage property's postal code.
B9NumOfProp	number	Optional Gets the Total number of properties secured by the particular mortgage.
B10Other	string	Optional Gets any other item lender wish to report to the recipient, such as real estate taxes, insurance paid from escrow etc.
B11AcqDate	string	Optional Gets the date of acquisition.
AccountNum	string	Gets the account number of lender having multiple accounts for a recipient for whom more than one Form 1098 is filed. 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

Success Response - This is a sample response for successful API requests.

{
  "StatusCode": 200,
  "StatusName": "Ok",
  "StatusMessage": "Successful API call",
  "Form1098Records": [
    {
      "SubmissionManiFest": {
        "SubmissionId": "c03feb88-d8a1-4080-8bc6-4e6adec1bba5",
        "TaxYear": "2024",
        "IRSFilingType":"IRIS",
        "IsFederalFiling": true,
        "IsPostal": true,
        "IsOnlineAccess": true,
        "IsScheduleFiling": false,
        "ScheduleFiling": null
      },
      "ReturnHeader": {
        "Business": {
          "BusinessId": "8d177248-992e-4ca5-ba9e-1a5a8a93db56",
          "PayerRef": "Snow123",
          "BusinessNm": "Snowdaze LLC",
          "FirstNm": "James",
          "MiddleNm": null,
          "LastNm": "Smith",
          "Suffix": null,
          "TradeNm": "Iceberg Icecreams",
          "IsEIN": true,
          "EINorSSN": "71-3787159",
          "Email": "james@sample.com",
          "ContactNm": null,
          "Phone": "(663) 456-7890",
          "PhoneExtn": "12345",
          "Fax": "(663) 456-7890",
          "BusinessType": "ESTE",
          "SigningAuthority": null,
          "KindOfEmployer": "FEDERALGOVT",
          "KindOfPayer": "REGULAR941",
          "IsBusinessTerminated": true,
          "IsForeign": false,
          "USAddress": {
            "Address1": "3576 AIRPORT WAY",
            "Address2": "UNIT 9",
            "City": "FAIRBANKS",
            "State": "AK",
            "ZipCd": "99709"
          },
          "ForeignAddress": null,
          "IsGovernmentalUnit": false
        }
      },
      "ReturnData": [
        {
          "RecordId": "488b1c7e-d244-4d6a-8491-65ae2209a99f",
          "SequenceId": "1",
          "IsPostal": false,
          "IsOnlineAccess": true,
          "IsForced": true,
          "Recipient": {
            "RecipientId": "472079fb-2dcf-4228-8548-73656ddafc30",
            "TINType": "SSN",
            "TIN": "363-81-4579",
            "PayeeRef": "Payee001",
            "FirstPayeeNm": "Dairy Delights LLC",
            "SecondPayeeNm": "Coco Milk",
            "FirstNm": "Shawn",
            "MiddleNm": null,
            "LastNm": "Williams",
            "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": "(683) 456-7890",
            "Phone": "7634567890"
          },
          "Form1098Data": {
            "B1IntRec": 10000,
              "B2OutPrin": 75000,
              "B3OrgDate": "03/04/2023",
              "B4RfdPd": 700,
              "B5MIP": 700,
              "B6PtsPd": 2000,
              "B7PropAddSameAsRec": false,
              "B8PropDescr": {
                "Descr": "Bremne",
                "IsForeign": false,
                "USAddress": {
                  "Address1": "120 Bremner Blvd",
                  "Address2": "Suite 800",
                  "City": "FAIRBANKS",
                  "State": "AK",
                  "ZipCd": "99709"
                },
                "ForeignAddress": null
            },
              "B9NumOfProp": 0,
              "B10Other": "Residential tax paid for the recipient",
              "B11AcqDate": null,
              "AccountNum": "ABC001"
          }
        }
      ]
    }
  ],
  "Errors": null
}