Skip to main content
Version: 1.7.3

List

GET Form5498ESA/List 
Run in Postman

Request Params

FieldTypeDescription
SubmissionIdGuidUnique identifier of a submission
BusinessIdGuidUnique identifier of a business
TINTypestringList the 5498 ESA records based on the given TINType and TIN.
TINstringList the 5498 ESA records based on the given TIN.
TaxYearstringList the 5498 ESA records based on the given taxyear.
Allowed values:"2023","2024"
PagenumberPulls the records listed in the page selected
PageSizenumberNumber of 5498 ESA records to be listed in each page.
Note: PageSize can be maximum of 100.
EfileStatusstringList the 5498 ESA records based on the status ("CREATED, UNDERPROCESS, SENTTOAGENCY, TRANSMITTED, ACCEPTED, REJECTED")
FromDatestringEnter a date from which the Form 5498 ESA records need to be listed in MM/DD/YYYY format.
ToDatestringEnter a date till which the 5498 ESA records created are to be listed in MM/DD/YYYY format.

Request Params

Form5498ESA/List?BusinessId=dd5480a8-92ed-4353-a893-f9187f7122ae

Response Body

FieldTypeDescription
StatusCodenumberReturns the HTTP status codes like 200,300 etc.
StatusNamestringName of the status code
StatusMessagestringDetailed status message
Form5498ESATypestringDenotes the type of 5498 ESA form.
Form5498ESARecordsobject[]Returns detailed information of the Form 5498 ESA records.
    SubmissionIdGuidUnique identifier of a submission
    BusinessIdGuidUnique identifier of a business
    PayerRefstringUnique identifier of the payer.
    BusinessNmstringName of the business
        FirstNmstringFirst Name of the Individual
        MiddleNmstringMiddle Name of the Individual
        LastNmstringLast Name of the Individual
        SuffixstringSuffix of the Individual
    EINorSSNstringWhen IsEIN is true, use Employer Identification Number (EIN). When IsEIN is false, use Social Security Number (SSN)
    ContactNmstringContact Name of the Business.
    TaxYearstringTax year of 5498 ESA to be filed.
    RecipientobjectDetails of the Recipient.
        SequenceIdstringA unique number given by an inbound application to identify failed records.
        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.
        RecipientNmBooleanName of Recipient.
        FirstNmstringFirst Name of the Individual
        MiddleNmstringMiddle Name of the Individual
        LastNmstringLast Name of the Individual
        SuffixstringSuffix of the Individual
        TINstringTIN of the Recipient.
        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.
TotalRecordsnumberTotal number of records.
TotalPagesnumberTotal number of pages.
PagenumberPulls the records listed in the page selected.
PageSizenumberNumber of 5498 ESA records to be listed in each page.
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",
"Form5498Type": "5498ESA",
"Form5498ESARecords": [
{
"SubmissionId": "3d8778f5-fd55-4d0b-94ff-327bd10e0b4b",
"BusinessId": "dd5480a8-92ed-4353-a893-f9187f7122ae",
"PayerRef": "Snow123",
"BusinessNm": "Snowdaze LLC",
"FirstNm": null,
"LastNm": null,
"MiddleNm": null,
"Suffix": null,
"IsEIN": true,
"EINorSSN": "35-2145881",
"ContactNm": "James",
"TaxYear": "2024",
"Recipient": {
"SequenceId": "01",
"RecordId": "1310081c-c887-4619-8eb0-0a6612056de5",
"RecipientId": "2a208545-6651-4ffd-b1c8-e871b7e6dc3b",
"RecipientNm": "Dairy Delights LLC Coco Milk",
"FirstNm": null,
"LastNm": null,
"MiddleNm": null,
"Suffix": null,
"TINType": "EIN",
"TIN": "66-9846542",
"PayeeRef": "Payee001",
"AccountNum": "20241520058563079953",
"FederalReturn": {
"Status": "CREATED",
"StatusTs": "2024-07-01 06:45:05 -04:00",
"Info": null,
"Errors": null
},
"Postal": null,
"OnlineAccess": {
"Status": "CREATED",
"Email": "dairy@sample.com",
"Info": null
},
"ScheduleFiling": {
"ScheduledOn": "01/25/2025",
"Info": "The return is scheduled on 01/25/2025"
}
}
}
],
"TotalRecords": 1,
"TotalPages": 1,
"Page": 1,
"PageSize": 100,
"Errors": null
}