Skip to main content
Version: 1.7.3

Status

GET Form5498ESA/Status
Run in Postman

Request Params

FieldTypeDescription
SubmissionIdGuidUnique identifier of a submission.
RecordIdsGuidNumber of record Ids to get status.

Request Params

Get status with only the SubmissionID

Form5498ESA/Status?SubmissionId=a1fd86fb-e404-442d-ae37-c5f6d1a1cc14&RecordIds=2d9309cd-5b5b-42bf-b68a-c237c9b2c67e

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
BusinessIdGuidUnique identifier of a Business.
PayerRefstringUnique identifier of the payer.
Form5498ESATypestringDenotes the type of 5498 ESA form.
Form5498ESARecordsobjectPulls Form 5498 ESA records with Success and Error statuses
    SuccessRecordsobject[]It will show 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.
        RecordIdGuidAn unique identifier generated by TaxBandits when a 5498 ESA return is created.
        RecipientIdGuidAn 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.
        PayeeRefstringA unique identifier for each payee completing their information.
        AccountNumstringAccount 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.
        FederalReturnobjectReturns the record status and StatusTs of federal return.
            StatusstringReturns the record status.
            StatusTsstringReturns date and time of return created.
            InfostringReturns information about the Federal Filing service.
            Errorsobject[]Shows error information in state returns of Form 5498 ESA
        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.
        ScheduleFilingobjectReturns the date of the schedule filing.
            ScheduledOnstringDate of the schedule filing to know when the return to be filed to the IRS.
            InfostringInformation about Schedule Filing 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 error.

Response JSON

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

{
    "StatusCode": 200,
    "StatusName": "Ok",
    "StatusMessage": "Successful API call",
    "SubmissionId": "a1fd86fb-e404-442d-ae37-c5f6d1a1cc14",
    "BusinessId": "e097c642-f1cf-48b0-88fc-01c1197647c3",
    "PayerRef": "Snow123",
    "Form5498Type": "5498ESA",

    "Form1099Records": {
        "SuccessRecords": [
            {
                "SequenceId": "1",
                "RecordId": "2d9309cd-5b5b-42bf-b68a-c237c9b2c67e",
                "RecipientId": "1325f550-cc2b-484a-8173-83ffb805e6cf",
                "PayeeRef": "Payee001",
                "AccountNum": "20241520058563079953",
                "FederalReturn": {
                    "Status": "TRANSMITTED",
                    "StatusTs": "2024-06-05 06:54:28 -04:00",
                    "Info": null,
                    "Errors": null
                },
               
                "Postal": {
                    "Status": "CREATED",
                    "StatusTs": "2024-06-05 06:54:28 -04:00",
                    "Info": null
                },
                "OnlineAccess": {
                    "Status": "EMAIL_SENT",
                    "Email": "shawn@sample.com",
                    "Info": null
                },
                "ScheduleFiling": {
                    "ScheduledOn": null,
                    "Info": "This service will be available soon"
                }
            },
            {
                "SequenceId": "2",
                "RecordId": "bd312551-60fe-4775-a8e3-a48acc96899b",
                "RecipientId": "1325f550-cc2b-484a-8173-83ffb805e6cf",
                "PayeeRef": "Payee002",
                "AccountNum": "20248765438563079953",
                "FederalReturn": {
                    "Status": "SENT TO AGENCY",
                    "StatusTs": "2024-06-05 06:55:08 -04:00",
                    "Info": null,
                    "Errors": null
                },
                               "Postal": {
                    "Status": "CREATED",
                    "StatusTs": "2024-06-05 06:56:04 -04:00",
                    "Info": null
                },
                "OnlineAccess": {
                    "Status": "EMAIL_SENT",
                    "Email": "shawn@sample.com",
                    "Info": null
                },
                "ScheduleFiling": {
                    "ScheduledOn": null,
                    "Info": "This service will be available soon"
                }
            },
            {
                "SequenceId": "3",
                "RecordId": "a051a093-2d40-4bdd-80a7-c102b489da38",
                "RecipientId": "1325f550-cc2b-484a-8173-83ffb805e6cf",
                "PayeeRef": "Payee003",
                "AccountNum": "20241520058563098543",
                "FederalReturn": {
                    "Status": "ACCEPTED",
                    "StatusTs": "2024-06-05 06:55:16 -04:00",
                    "Info": null,
                    "Errors": null
                },
                "Postal": {
                    "Status": "CREATED",
                    "StatusTs": "2024-06-05 06:56:13 -04:00",
                    "Info": null
                },
                "OnlineAccess": {
                    "Status": "EMAIL_SENT",
                    "Email": "shawn@sample.com",
                    "Info": null
                },
                "ScheduleFiling": {
                    "ScheduledOn": null,
                    "Info": "This service will be available soon"
                }
            },
            {
                "SequenceId": "4",
                "RecordId": "124355cd-b7ed-4103-8214-1b7f78980f74",
                "RecipientId": "1325f550-cc2b-484a-8173-83ffb805e6cf",
                "PayeeRef": "Payee004",
                "AccountNum": "2024152005856654213",
                "FederalReturn": {
                    "Status": "REJECTED",
                    "StatusTs": "2024-06-05 06:55:16 -04:00",
                    "Info": null,
                    "Errors": [
                        {
                            "Id": "F68-FED-10001",
                            "Name": "Rejected Record",
                            "Message": "Sample Error Message"
                        }
                    ]
                },
               "Postal": {
                    "Status": "CREATED",
                    "StatusTs": "2024-06-05 06:56:13 -04:00",
                    "Info": null
                },
                "OnlineAccess": {
                    "Status": "EMAIL_SENT",
                    "Email": "shawn@sample.com",
                    "Info": null
                },
                "ScheduleFiling": {
                    "ScheduledOn": null,
                    "Info": "This service will be available soon"
                }
            }
        ],
        "ErrorRecords": null
    },
    "Errors": null
}