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?BusinessId=dd5480a8-92ed-4353-a893-f9187f7122ae
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 |
FirstNm | string | First Name of the Individual |
MiddleNm | string | Middle Name of the Individual |
LastNm | string | Last Name of the Individual |
Suffix | string | Suffix of the Individual |
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. |
FirstNm | string | First Name of the Individual |
MiddleNm | string | Middle Name of the Individual |
LastNm | string | Last Name of the Individual |
Suffix | string | Suffix of the Individual |
TIN | string | TIN of the Recipient. |
PayeeRef | string | A unique identifier for each payee completing their information. |
AccountNum | string | Account 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. |
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. |
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
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
}
}
}
],
"TotalRecords": 1,
"TotalPages": 1,
"Page": 1,
"PageSize": 100,
"Errors": null
}