Status
This method will return the current status of Form 1098-E for a particular submission or for a particular recipient.
Federal
- Created: Form 1098-E has been created and not yet transmitted by the user.
- Transmitted: Form 1098-E has been transmitted by the user.
- Order Received: Form 1098-E order is received and waiting in our efile queue.
- Under Process: Our efile system is processing the Form 1098-E which will be sent to the IRS soon.
- Sent to Agency: Form 1098-E has been sent to the SSA and we are waiting for the result from IRS.
- Accepted: Form 1098-E is accepted by the IRS.
- Rejected: Form 1098-E is rejected by the IRS due to some errors. Please correct the errors and retransmit them.
Postal Mailing
- Not Created: Postal Mailing is not opted for the return. IsPostalMailing in the submission manifest must be set as TRUE to enable postal mailing. Postal Mailing cannot be created for recipients with Foreign addresses.
- Created: Postal Mailing service is opted for the return and it will be sent as soon as the form is transmitted.
- Order Received: Postal Mailing order has been received and the mails will be sent out soon.
- Order Sent: Postal Mailing order has been sent and the recipient will receive the copy soon.
Online Access
- Not Created: Online Access service is not opted for the return. IsOnlineAccess in the submission manifest must be set as TRUE to enable Online Access. Email Address is required to create Online Access.
- Created: Online Access service is opted for the return and the email with a secure link to download their forms will be sent to the recipients as soon as the form is transmitted.
- Order Received: Online Access order has been received and the email will be sent to the recipient soon.
- Email Sent: Online Access email with a secure link to download the form has been sent to the recipient and the recipient is yet to view the form.
- Viewed Form: Recipient has successfully viewed the form.
- Downloaded Form: Recipient has successfully viewed and downloaded the form.
GET Form1098E/Status
Request Params
Field | Type | Description |
---|---|---|
SubmissionId | Guid | Unique identifier of a submission |
RecordIds | string | Number of record Ids to get status. |
Request Params
- Sample 1
- Sample 2
Get status with only the SubmissionID
"Form1098E/Status?SubmissionId=9d71ae45-df5f-49f7-86f8-e88f54132fa1&RecordIds=01132f6d-ef4a-4014-817e-94a5a19bd52b"
Get status with SubmissionID and 2 RecordIDs
"Form1098E/Status?SubmissionId=b8b7d0ad-51e2-424a-bc46-8425de87f7c7&RecordIds=b230f379-74fb-4c00-8d9e-948733ff5c12, def3591c-7c66-4d15-a8b1-c36f22e90150"
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. |
PayerRef | string | Unique identifier of a Payer. |
Form1098Type | string | Denotes the type of 1098 E form. |
Form1098ERecords | object | Pulls Form 1098 E records with Success and Error statuses |
SuccessRecords | object[] | It will show the detailed information about the success status of Form 1098 E 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 | 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. |
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. |
string | Email address for whom the online access to be given. | |
Info | string | Information about the online access service. |
ScheduleFiling | object | Returns the date of the schedule filing. |
ScheduledOn | string | Date of the schedule filing to know when the return to be filed to the IRS. |
Info | string | Information about Schedule Filing service. |
ErrorRecords | object[] | It will show the detailed information about the error status of Form 1098 E Records. |
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
- 404
Success Response - This is a sample response for successful API requests.
{
"StatusCode": 200,
"StatusName": "Ok",
"StatusMessage": "Successful API call",
"SubmissionId": "ca4505f2-66c7-4981-932e-4a0c6dd534f4",
"BusinessId": "23523b64-3365-43f8-ab80-d6848573e230",
"PayerRef": "Snow123",
"Form1098Type": "E",
"Form1098ERecords": {
"SuccessRecords": [
{
"SequenceId": "1",
"RecordId": "3eea819c-e9e8-4fdf-a6e3-ffb5925142b1",
"RecipientId": "7709789d-c37f-4bae-90e0-b63636fc8e76",
"FederalReturn": {
"Status": "CREATED",
"StatusTs": "2024-06-27 06:22:17 -04:00",
"Info": null,
"Errors": null
},
"Postal": null,
"OnlineAccess": {
"Status": "CREATED",
"Email": "shawn+1@sample.com",
"Info": null
},
"ScheduleFiling": null
},
{
"SequenceId": "2",
"RecordId": "bb32beda-c801-4a82-af46-8a4146fc939f",
"RecipientId": "7709789d-c37f-4bae-90e0-b63636fc8e76",
"FederalReturn": {
"Status": "TRANSMITTED",
"StatusTs": "2024-06-27 06:23:38 -04:00",
"Info": null,
"Errors": null
},
"Postal": null,
"OnlineAccess": {
"Status": "EMAIL_SENT",
"Email": "shawn+1@sample.com",
"Info": null
},
"ScheduleFiling": null
},
{
"SequenceId": "3",
"RecordId": "800da799-a6d9-4949-9109-fb054278389c",
"RecipientId": "7709789d-c37f-4bae-90e0-b63636fc8e76",
"FederalReturn": {
"Status": "SENT TO AGENCY",
"StatusTs": "2024-06-27 06:24:06 -04:00",
"Info": null,
"Errors": null
},
"Postal": null,
"OnlineAccess": {
"Status": "EMAIL_SENT",
"Email": "shawn+1@sample.com",
"Info": null
},
"ScheduleFiling": null
},
{
"SequenceId": "4",
"RecordId": "40d97097-ec2a-4305-a92f-8b63da7aa151",
"RecipientId": "7709789d-c37f-4bae-90e0-b63636fc8e76",
"FederalReturn": {
"Status": "ACCEPTED",
"StatusTs": "2024-06-27 06:24:16 -04:00",
"Info": null,
"Errors": null
},
"Postal": null,
"OnlineAccess": {
"Status": "EMAIL_SENT",
"Email": "shawn+1@sample.com",
"Info": null
},
"ScheduleFiling": null
},
{
"SequenceId": "5",
"RecordId": "a7b20acc-d909-4322-94dd-c2459a57f668",
"RecipientId": "7709789d-c37f-4bae-90e0-b63636fc8e76",
"FederalReturn": {
"Status": "REJECTED",
"StatusTs": "2024-06-27 06:24:16 -04:00",
"Info": null,
"Errors": [
{
"Id": "F68-FED-10001",
"Name": "Rejected Record",
"Message": "Sample Error Message"
}
]
},
"Postal": null,
"OnlineAccess": {
"Status": "EMAIL_SENT",
"Email": "shawn+1@sample.com",
"Info": null
},
"ScheduleFiling": null
}
],
"ErrorRecords": null
},
"Errors": null
}
Bad Request Response - You'll get the below response when your API requests contain any validation errors.
{
"StatusCode": 300,
"StatusName": "MultiStatus",
"StatusMessage": "Multiple statuses are available for the request",
"SubmissionId": "ca4505f2-66c7-4981-932e-4a0c6dd534f4",
"BusinessId": "23523b64-3365-43f8-ab80-d6848573e230",
"PayerRef": "Snow123",
"Form1098Type": "E",
"Form1098ERecords": {
"SuccessRecords": [
{
"SequenceId": "1",
"RecordId": "3eea819c-e9e8-4fdf-a6e3-ffb5925142b1",
"RecipientId": "7709789d-c37f-4bae-90e0-b63636fc8e76",
"FederalReturn": {
"Status": "CREATED",
"StatusTs": "2024-06-27 06:22:17 -04:00",
"Info": null,
"Errors": null
},
"Postal": null,
"OnlineAccess": {
"Status": "CREATED",
"Email": "shawn+1@sample.com",
"Info": null
},
"ScheduleFiling": null
}
],
"ErrorRecords": [
{
"SequenceId": null,
"RecordId": "472079fb-2dcf-4228-8548-73656ddafc30",
"Errors": [
{
"Id": "F00-100192",
"Name": "RecordId",
"Message": "Invalid RecordId"
}
]
}
]
},
"Errors": [
{
"Id": "F00-100155",
"Name": "Error Records",
"Message": "Some of the records are errored. Please read the Error Records for more details."
}
]
}
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",
"SubmissionId": "ca4505f2-66c7-4981-932e-4a0c6dd534f4",
"BusinessId": null,
"PayerRef": null,
"Form1098Type": "E",
"Form1098ERecords": {
"SuccessRecords": null,
"ErrorRecords": [
{
"SequenceId": null,
"RecordId": "472079fb-2dcf-4228-8548-73656ddafc30",
"Errors": [
{
"Id": "F00-100192",
"Name": "RecordId",
"Message": "Invalid RecordId"
}
]
}
]
},
"Errors": null
}