Status
GET Form5498ESA/Status
Request Params
Field | Type | Description |
---|---|---|
SubmissionId | Guid | Unique identifier of a submission. |
RecordIds | Guid | Number of record Ids to get status. |
Request Params
"Form5498ESA/Status?SubmissionId=215e8a7a-bea1-4aaf-8fbc-8cafd6d71db7&RecordIds=45612bd4-cab9-4518-aafe-4c267dddb66d"
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 the payer. |
Form5498ESAType | string | Denotes the type of 5498 ESA form. |
Form5498ESARecords | object | Pulls Form 5498 ESA records with Success and Error statuses |
SuccessRecords | object[] | It will show detailed information about the success status of Form 5498 ESA 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 | An unique identifier generated by TaxBandits when a 5498 ESA return is created. |
RecipientId | Guid | An unique identifier generated by TaxBandits for a Recipient when a 5498 ESA 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 5498 ESA |
Postal | object | Returns the status and StatusTs of postal mailing service for Form 5498 ESA . |
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 5498 ESA 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 5498 ESA 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. |
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. |
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
{
"StatusCode": 200,
"StatusName": "Ok",
"StatusMessage": "Successful API call",
"SubmissionId": "215e8a7a-bea1-4aaf-8fbc-8cafd6d71db7",
"BusinessId": "f09692ad-d041-45ea-a439-de1b4690d722",
"PayerRef": null,
"Form5498Type": "5498ESA",
"Form5498ESARecords": {
"SuccessRecords": [
{
"SequenceId": "1",
"RecordId": "45612bd4-cab9-4518-aafe-4c267dddb66d",
"RecipientId": "b43d8b2c-735e-4929-94ae-af4220ba7056",
"FederalReturn": {
"Status": "CREATED",
"StatusTs": "2023-10-30 06:59:45 -04:00",
"Info": null,
"Errors": null
},
"Postal": {
"Status": "CREATED",
"StatusTs": "2023-10-30 06:59:45 -04:00",
"Info": null
},
"OnlineAccess": {
"Status": "CREATED",
"Email": "sample@bodeem.com",
"Info": null
},
"ScheduleFiling": {
"ScheduledOn": null,
"Info": "This service will be available soon"
}
}
],
"ErrorRecords": null
},
"Errors": null
}