List
GET Form5498/List
Request Params
Field | Type | Description |
---|---|---|
SubmissionId | Guid | Unique identifier of a submission |
BusinessId | Guid | Unique identifier of a business |
TINType | string | List the 5498 records based on the given TINType and TIN. |
TIN | string | List the 5498 records based on the given TIN. Size Range:9 |
TaxYear | string | List the 5498 records based on the given taxyear. Allowed values: "2022","2023" |
Page | number | Pulls the records listed in the page selected |
PageSize | number | Number of 5498 records to be listed in each page. |
EfileStatus | string | List the 5498 records based on the status ("CREATED, UNDERPROCESS, SENTTOAGENCY, TRANSMITTED, ACCEPTED, REJECTED") |
FromDate | string | Enter a date from which the Form 5498 records need to be listed in MM/DD/YYYY format. |
ToDate | string | Enter a date till which the 5498 records created are to be listed in MM/DD/YYYY format. |
Request Params
"Form5498/List?SubmissionId=eeee66d3-5291-4675-828a-f153616e99ca&BusinessId=e03eff49-ceb4-4d5a-a991-a50e6be69fb3&TINType=EIN&TIN=804663137&TaxYear=2023&Page=1&PageSize=10&EfileStatus=ALL&FromDate=11-01-2023&ToDate=11-30-2023"
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 |
Form5498Type | string | Denotes the type of 5498 form. |
Form5498Records | object[] | Returns detailed information of the Form 5498 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 to be filed. |
Recipient | object | Details of the Recipient. |
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 return is created. |
RecipientId | Guid | An unique identifier generated by TaxBandits for a Recipient when a 5498 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. |
Postal | object | Returns the status and StatusTs of postal mailing service for Form 5498. |
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. |
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. |
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 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 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": "5498",
"Form5498Records": [
{
"SubmissionId": "eeee66d3-5291-4675-828a-f153616e99ca",
"BusinessId": "e03eff49-ceb4-4d5a-a991-a50e6be69fb3",
"PayerRef": "AB12E",
"BusinessNm": "Snowdaze LLC",
"IsEIN": true,
"EINorSSN": "80-4663137",
"ContactNm": "John",
"TaxYear": "2023",
"Recipient": {
"SequenceId": "1",
"RecordId": "c0bfc6ce-9c6e-4031-8ab5-3d1099e1c0e7",
"RecipientId": "1af70d8b-9b55-4139-84bd-aedcb7fdfa07",
"RecipientNm": "Milo Schmeler",
"TINType": "SSN",
"TIN": "141-25-6859",
"FederalReturn": {
"Status": "CREATED",
"StatusTs": "2023-10-31 09:10:04 -04:00",
"Info": null,
"Errors": null
},
"Postal": {
"Status": "CREATED",
"StatusTs": "2023-10-31 09:10:04 -04:00",
"Info": null
},
"OnlineAccess": {
"Status": "CREATED",
"Email": "sample@bodeem.com",
"Info": null
}
}
}
],
"TotalRecords": 1,
"TotalPages": 1,
"Page": 1,
"PageSize": 100,
"Errors": null
}