Skip to main content
Version: 1.7.3

Transmit

POST Form5498ESA/Transmit 
Run in Postman

Request Body

FieldTypeDescription
SubmissionIdGuidAn unique identifier generated by TaxBandits when a 5498 ESA return is created. Mention the 5498 ESA return's Submission ID that you want to transmit.
RecordIdsGuid[]An unique identifier generated by TaxBandits when a 5498 ESA return is created. Mention the 5498 ESA return's Record ID that you want to transmit.

Request JSON

{
"SubmissionId": "9f8066d5-3759-4286-976c-92ee3f930e1c",
"RecordIds": [
"f3a195de-dc83-43b4-9897-b5148fe597b7"
]
}

Response Body

FieldTypeDescription
StatusCodenumberReturns the HTTP status codes like 200,300 etc.
StatusNamestringName of the status code
StatusMessagestringDetailed status message
SubmissionIdGuidUnique identifier of a submission
Form5498ESARecordsobjectPulls the Form 5498 ESA records with Success and Error statuses
    SuccessRecordsobject[]It will show the detailed information about the success status of Form 5498 ESA Records
        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.
        RecordIdGuidUnique identifier of a record
        StatusstringReturns the status of the records.
        StatusTsstringDate and Time of the Return Transmission
        PostalobjectReturns the status and StatusTs of postal mailing service for Form 5498 ESA.
            StatusstringReturns the status of postal order.
            StatusTsstringReturns the date and time of the postal order created.
            InfostringReturns the information about Postal mailing service.
        OnlineAccessobjectReturns the Email address for whom the online access to be given and Status of online access.
            StatusstringReturns status of online access for Form 5498 ESA return.
            EmailstringEmail address for whom the online access to be given.
            InfostringInformation about the online access service.
    ErrorRecordsobject[]It will show the detailed information about the error status of Form 5498 ESA Records.
        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.
        RecordIdGuidUnique identifier of a record
        Errorsobject[]Shows detailed error information
            IdstringReturns the validation error Id
            NamestringName of the validation error
            MessagestringDescription of the validation error
Errorsobject[]Shows detailed error information
    IdstringReturns the validation error Id.
    NamestringName of the validation error.
    MessagestringDescription of the validation erro.r

Response JSON

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

{
"StatusCode": 200,
"StatusName": "Ok",
"StatusMessage": "Successful API call",
"SubmissionId": "14e2441e-a735-4b78-9bbb-361cd380d8ad",
"Form5498ESARecords": {
"SuccessRecords": [
{
"SequenceId": "1",
"RecordId": "18bd6308-9ff9-48a2-aadb-ce7ae39a0627",
"Status": "Transmitted",
"StatusTs": "2023-10-30 07:04:57 -04:00",
"OnlineAccess": {
"Status": "ORDER_CREATED",
"Email": "sample@bodeem.com",
"Info": "Recipient will receive an email with an unique URL to access their form online"
},
"Postal": {
"Status": "RECEIVED",
"StatusTs": "2023-10-30 07:04:57 -04:00",
"Info": null
}
}
],
"ErrorRecords": null
},
"Errors": null
}