Status
GET Form5498/Status
Request Params
Field | Type | Description |
---|---|---|
SubmissionId | Guid | Unique identifier of a submission |
RecordId | Guid | An unique identifier generated by TaxBandits when a 5498 return is created. |
Request Params
- Sample 1
- Sample 2
Get status with only the SubmissionID
Form5498/Status?SubmissionId=9d71ae45-df5f-49f7-86f8-e88f54132fa1&RecordIds=01132f6d-ef4a-4014-817e-94a5a19bd52b
Get status with SubmissionID and 2 RecordIDs
Form5498/Status?SubmissionId=b8b7d0ad-51e2-424a-bc46-8425de87f7c7&RecordIds=b230f379-74fb-4c00-8d9e-948733ff5c12, def3591c-7c66-4d15-a8b1-c36f22e90150
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 |
SubmissionId | Guid | Unique identifier of a submission |
BusinessId | Guid | Unique identifier of a Business. |
PayerRef | string | Unique identifier of the payer. |
Form5498Type | string | Denotes the type of 5498 form. |
Form5498Records | object | Pulls Form 5498 records with Success and Error statuses |
SuccessRecords | object[] | It will show detailed information about the success status of Form 5498 Records |
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. |
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 |
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. |
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. |
ScheduleFiling | object | Returns the date of the schedule filing. |
ErrorRecords | object[] | It will show the detailed information about the error status of Form 5498 Records. |
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 | Unique identifier of a record |
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 |
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
- 200
- 300
- 404
Success Response - This is a sample response for successful API requests.
{
"StatusCode": 200,
"StatusName": "Ok",
"StatusMessage": "Successful API call",
"SubmissionId": "f14cf437-c3a3-4413-8ea6-bea04613ffbf",
"BusinessId": "6c1f489f-7f6f-4853-a269-b6149ff2f4f4",
"PayerRef": null,
"Form5498Type": "5498",
"Form5498Records": {
"SuccessRecords": [
{
"SequenceId": "1",
"RecordId": "b95e4183-bf8d-4812-a808-199823ced336",
"RecipientId": "eff36c38-4592-427a-8405-dfa187cde82e",
"AccountNum":"20241520058563079953",
"PayeeRef": "Payee001",
"FederalReturn": {
"Status": "CREATED",
"StatusTs": "2024-07-01 08:25:54 -04:00",
"Info": null,
"Errors": null
},
"Postal": null,
"OnlineAccess": {
"Status": "CREATED",
"Email": "shawn@sample.com",
"Info": null
},
"ScheduleFiling": null
}
],
"ErrorRecords": null
},
"Errors": null
}
Multi-status Response - You'll get the below response when multiple statuses are included.
{
"StatusCode": 300,
"StatusName": "MultiStatus",
"StatusMessage": "Multiple statuses are available for the request",
"SubmissionId": "f14cf437-c3a3-4413-8ea6-bea04613ffbf",
"BusinessId": "6c1f489f-7f6f-4853-a269-b6149ff2f4f4",
"PayerRef": null,
"Form5498Type": "5498",
"Form5498Records": {
"SuccessRecords": [
{
"SequenceId": "1",
"RecordId": "b95e4183-bf8d-4812-a808-199823ced336",
"RecipientId": "eff36c38-4592-427a-8405-dfa187cde82e",
"AccountNum":"20241520058563079342",
"PayeeRef": "Payee002",
"FederalReturn": {
"Status": "CREATED",
"StatusTs": "2024-07-01 08:25:54 -04:00",
"Info": null,
"Errors": null
},
"Postal": null,
"OnlineAccess": {
"Status": "CREATED",
"Email": "shawn@sample.com",
"Info": null
},
"ScheduleFiling": null
}
],
"ErrorRecords": [
{
"SequenceId": null,
"RecordId": "6c1f489f-7f6f-4853-a269-b6149ff2f4f4",
"Errors": [
{
"Id": "F00-100192",
"Name": "RecordId",
"Message": "Invalid RecordId"
}
]
}
]
},
"Errors": [
{
"Id": "F00-100155",
"Name": "Error Records",
"Message": "Some of the records are errored. Please read the Error Records for more details."
}
]
}
Not Found Response - You'll get the below response if your API request contains a record that's not found in our database.
{
"StatusCode": 404,
"StatusName": "NotFound",
"StatusMessage": "The resource you have specified cannot be found",
"SubmissionId": null,
"BusinessId": null,
"PayerRef": null,
"Form5498Type": "5498",
"Form5498Records": null,
"Errors": [
{
"Id": "F00-100186",
"Name": "SubmissionId",
"Message": "Invalid Submission Id"
}
]
}