List

GET Form5498ESA/List 

Request Params

Field	Type	Description
SubmissionId	Guid	Unique identifier of a submission
RecordIds	Guid[]	An unique identifier generated by TaxBandits when a 5498 ESA return is created. Mention the Form 5498 ESA return's Record ID that you want to get.

Request Params

"Form5498ESA/List?SubmissionId=6569920a-a668-4996-97c4-6cc739f4097f&Recordids=6a328715-6b13-4054-bacd-dca2f4bfa0f6"

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
Form5498ESAType	string	Denotes the type of 5498 ESA form.
Form5498ESARecords	object[]	Returns detailed information of the Form 5498 ESA records.
SubmissionId	Guid	Unique identifier of a submission
BusinessId	Guid	Unique identifier of a business
PayerRef	string	Unique identifier of the payer.
BusinessNm	string	Name of the business
IsEIN	Boolean	When true, identifies the business with an EIN.
EINorSSN	string	When IsEIN is true, use Employer Identification Number (EIN). When IsEIN is false, use Social Security Number (SSN)
ContactNm	string	Contact Name of the Business.
TaxYear	string	Tax year of 5498 ESA to be filed.
Recipient	object	Details of the Recipient.
SequenceId	string	A unique number given by an inbound application to identify failed records.
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.
RecipientNm	Boolean	Name of Recipient.
TINType	string	TIN type of the Recipient.
TIN	string	TIN of the Recipient.
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.
Email	string	Email address for whom the online access to be given.
Info	string	Information about the online access service.
TotalRecords	number	Total number of records.
TotalPages	number	Total number of pages.
Page	number	Pulls the records listed in the page selected.
PageSize	number	Number of 5498 ESA records to be listed in each page.
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",
    "Form5498Type": "5498SA",
    "Form5498SARecords": [
        {
            "SubmissionId": "02cb3594-5bc9-4e61-8d2b-1a8117139915",
            "BusinessId": "e922521d-33d9-4f17-96d5-21e8c3e0d1ce",
            "PayerRef": "Pe123",
            "BusinessNm": "Snowdaze LLC",
            "IsEIN": true,
            "EINorSSN": "62-7369245",
            "ContactNm": "John",
            "TaxYear": "2023",
            "Recipient": {
                "SequenceId": "1",
                "RecordId": "b7a85950-4ceb-49df-a999-32d3b98d732b",
                "RecipientId": "fe153087-9983-4f2f-92a5-3bbf6953109c",
                "RecipientNm": "Mark Davis",
                "TINType": "EIN",
                "TIN": "39-3817572",
                "FederalReturn": {
                    "Status": "CREATED",
                    "StatusTs": "2023-10-30 05:42:54 -04:00",
                    "Info": null,
                    "Errors": null
                },
                "Postal": {
                    "Status": "CREATED",
                    "StatusTs": "2023-10-30 05:42:54 -04:00",
                    "Info": null
                },
                "OnlineAccess": {
                    "Status": "CREATED",
                    "Email": "sample@bodeem.com",
                    "Info": null
                }
            }
        },
        {
            "SubmissionId": "02cb3594-5bc9-4e61-8d2b-1a8117139915",
            "BusinessId": "e922521d-33d9-4f17-96d5-21e8c3e0d1ce",
            "PayerRef": "Pe123",
            "BusinessNm": "Snowdaze LLC",
            "IsEIN": true,
            "EINorSSN": "62-7369245",
            "ContactNm": "John",
            "TaxYear": "2023",
            "Recipient": {
                "SequenceId": "1",
                "RecordId": "db8bf4cb-88c3-4d76-bbe0-33575adff411",
                "RecipientId": "a5d4f4f5-e1e3-4462-911a-cfe7546e5d84",
                "RecipientNm": "Mark Davis",
                "TINType": "EIN",
                "TIN": "36-3817572",
                "FederalReturn": {
                    "Status": "CREATED",
                    "StatusTs": "2023-10-30 05:48:30 -04:00",
                    "Info": null,
                    "Errors": null
                },
                "Postal": null,
                "OnlineAccess": null
            }
        },
           ],
    "TotalRecords": 4,
    "TotalPages": 1,
    "Page": 1,
    "PageSize": 250,
    "Errors": null
}