Transmit

Transmits the Form 1098 return to the IRS. You can Transmit a return successfully only if there are no validation errors in the return.

If you want to transmit all the returns under a Submission, pass only the SubmissionId in the Request.

If you are transmitting only particular Returns in a Submission, then pass the SubmissionId along with the specific RecordIds as an array under the SubmissionId.

Note: There will be a response delay considerably if you are passing the SubmissionId and RecordIds.

POST Form1098/Transmit 

Request Body

Field	Type	Description
SubmissionId	Guid	An unique identifier generated by TaxBandits when a 1098 return is created. Mention the 1098 return's Submission ID that you want to transmit.
RecordIds	Guid[]	An unique identifier generated by TaxBandits when a 1098 return is created. Mention the 1098 return's Record ID that you want to transmit.

Request JSON

{
  "SubmissionId": "932d2691-5e8f-45db-815a-4a97886773b3",
  "RecordIds": [
    "14dc0f70-16c7-48b7-88b0-e1a59315061c"
  ]
}

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
Form1098Records	object	Pulls the Form 1098 records with Success and Error statuses
SuccessRecords	object[]	It will show the detailed information about the success status of Form 1098 Records
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.
RecordId	Guid	Unique identifier of a record
Status	string	Returns the status of the records.
StatusTs	string	Date and Time of the Return Transmission
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.
Postal	object	Returns the status and StatusTs of postal mailing service for Form 1098.
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.
ErrorRecords	object[]	It will show the detailed information about the error status of Form 1098 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

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

{
    "StatusCode": 200,
    "StatusName": "Ok",
    "StatusMessage": "Successful API call",
    "SubmissionId": "932d2691-5e8f-45db-815a-4a97886773b3",
    "Form1098Records": {
        "SuccessRecords": [
            {
                "SequenceId": "1",
                "RecordId": "14dc0f70-16c7-48b7-88b0-e1a59315061c",
                "Status": "Transmitted",
                "StatusTs": "2023-05-11 10:51:12 +00:00",
                "Postal":null,
                "OnlineAccess": {
                    "Status": "ORDER_CREATED",
                    "Email": "shawn@sample.com",
                    "Info": "Recipient will receive an email with an unique URL to access their form online"
                }
            }
        ],
        "ErrorRecords": null
    }
}