List

Lists all Form 1098-E returns created and transmitted on the account for a particular Submission or Payer. Form 1098-E returns will be listed based on the filters sent in the Request.

GET Form1098E/List 

Request Params

Field	Type	Description
SubmissionId	Guid	Unique identifier of a submission
BusinessId	Guid	Unique identifier of a business
TINType	string	List the 1098 E records based on the given TINType and TIN.
TIN	string	List the 1098 E records based on the given TIN.
TaxYear	string	List the 1098 E records based on the given taxyear. Allowed values: "2023", "2024"
Page	number	Pulls the records listed in the page selected
PageSize	number	Number of 1098 E records to be listed in each page.
EfileStatus	string	List the 1098 E records based on the status ("CREATED, UNDERPROCESS, SENTTOAGENCY, TRANSMITTED, ACCEPTED, REJECTED")
FromDate	string	Enter a date from which the Form 1098 E records need to be listed in MM/DD/YYYY format.
ToDate	string	Enter a date till which the 1098 E records created are to be listed in MM/DD/YYYY format.

Request Params

"Form1098E/List?BusinessId=8d177248-992e-4ca5-ba9e-1a5a8a93db56"

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
Form1098Type	string	Denotes the type of 1098 E form.
Form1098ERecords	object[]	Pulls the Form 1098 E records with Success and Error statuses
SubmissionId	Guid	Unique identifier of a submission
BusinessId	Guid	Unique identifier of a business
PayerRef	string	Unique identifier of the payer.
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 individual Allowed values "Jr", "Sr", "I", "II", "III", "IV", "V", "VI", "VII"
IsEIN	Boolean	When true, identifies the business with an EIN.
EINorSSN	string	When IsEIN is true, use Employer Identification Number (EIN). When IsEIN is false, use Social Security Number (SSN)
ContactNm	string	Contact Name of the Business.
TaxYear	string	Tax year of 1098 E to be filed.
Recipient	object	Details of the Recipient.
SequenceId	string	A unique number given by an inbound application to identify failed records.
RecordId	Guid	An unique identifier generated by TaxBandits when a 1098 E return is created.
RecipientId	Guid	An unique identifier generated by TaxBandits for a Recipient when a 1098 E return is created. You can use this id for your future reference to Update.
RecipientNm	string	Name of Recipient.
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 individual Allowed values "Jr", "Sr", "I", "II", "III", "IV", "V", "VI", "VII"
TINType	string	TIN type of the Recipient.
TIN	string	TIN of the Recipient.
PayeeRef	string	A unique identifier for each payee completing their information.
AccountNum	string	Account number of Payer having multiple accounts for a recipient for whom more than one Form 1099-NEC 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.
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 in state returns of Form 1098 E
Postal	object	Returns the status and StatusTs of postal mailing service for Form 1098 E.
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 1098 return.
Email	string	Email address for whom the online access to be given.
Info	string	Information about the online access service.
TotalRecords	number	Total number of records.
TotalPages	number	Total number of pages.
Page	number	Pulls the records listed in the page selected
PageSize	number	Number of 1098 E records to be listed in each page.
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",
  "Form1098Type": "E",
  "Form1098ERecords": [
    {
      "SubmissionId": "c03feb88-d8a1-4080-8bc6-4e6adec1bba5",
      "BusinessId": "8d177248-992e-4ca5-ba9e-1a5a8a93db56",
      "PayerRef": "Snow123",
      "BusinessNm": "Snowdaze LLC",
      "FirstNm": null,
      "MiddleNm": null,
      "LastNm": null,
      "Suffix": null,
      "IsEIN": true,
      "EINorSSN": "71-3787159",
      "ContactNm": null,
      "TaxYear": "2024",
      "Recipient": {
        "SequenceId": "1",
        "RecordId": "488b1c7e-d244-4d6a-8491-65ae2209a99f",
        "RecipientId": "472079fb-2dcf-4228-8548-73656ddafc30",
        "RecipientNm": null,
        "FirstNm": "Shawn",
        "MiddleNm": null,
        "LastNm": "Williams",
        "Suffix": null,
        "TINType": "SSN",
        "TIN": "363-81-4579",
        "PayeeRef": "Payee001",
        "AccountNum": "20241520058563079953",
        "FederalReturn": {
          "Status": "CREATED",
          "StatusTs": "2024-04-18 05:31:03 -04:00",
          "Info": null,
          "Errors": null
        },
        "Postal": null,
        "OnlineAccess": {
          "Status": "CREATED",
          "Email": "shawn@sample.com",
          "Info": null
        }
      }
    }
  ],
  "TotalRecords": 1,
  "TotalPages": 1,
  "Page": 1,
  "PageSize": 100,
  "Errors": null
}