Status
GET Form5498SA/status
Request Params
Field | Type | Description |
---|---|---|
SubmissionId | Guid | Unique identifier of a submission |
RecordId | Guid | OptionalAn unique identifier generated by TaxBandits when a 5498-SA return is created. |
Request Params
- Sample 1
- Sample 2
Get status with only the SubmissionID
"Form5498SA/status?SubmissionId=f808f471-053d-4777-b8f7-a52a8c4f49ea"
"Form5498SA/status?SubmissionId=f808f471-053d-4777-b8f7-a52a8c4f49ea&RecordIds=f474e884-8db6-4eaa-95ba-522bf5ae2c1f"
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. |
Form5498SAType | string | Denotes the type of 5498 SA form. |
Form5498SARecords | object | Pulls Form 5498 SA records with Success and Error statuses |
SuccessRecords | object[] | It will show detailed information about the success status of Form 5498 SA 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 | A unique identifier generated by TaxBandits when a 5498 SA return is created. |
RecipientId | Guid | An unique identifier generated by TaxBandits for a Recipient when a 5498 SA return is created. You can use this id for your future reference to update. |
FederalReturn | object | Returns the record status and StatusTs of federal return. |
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. |
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 SA. |
Postal | object | Returns the status and StatusTs of postal mailing service for Form 5498 SA . |
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 SA 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. |
ScheduledOn | string | Date of the schedule filing to know when the return to be filed to the IRS. |
Info | string | Information about Schedule Filing service. |
ErrorRecords | object[] | It will show the detailed information about the error status of Form 5498 SA 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
- 400
Success Response - This is a sample response for successful API requests.
{
"StatusCode": 200,
"StatusName": "Ok",
"StatusMessage": "Successful API call",
"SubmissionId": "f808f471-053d-4777-b8f7-a52a8c4f49ea",
"BusinessId": "f87e6f65-b036-4cad-9c20-a03200d9a1c7",
"PayerRef": "RN123",
"Form5498Type": "5498SA",
"Form5498SARecords": {
"SuccessRecords": [
{
"SequenceId": "1",
"RecordId": "f474e884-8db6-4eaa-95ba-522bf5ae2c1f",
"RecipientId": "9b0beedf-c980-404b-9c33-1007f5ff943c",
"PayeeRef": "Payee001",
"AccountNum": "20241520058563079953",
"FederalReturn": {
"Status": "CREATED",
"StatusTs": "2024-07-02 03:38:31 -04:00",
"Info": null,
"Errors": null
},
"Postal": {
"Status": "CREATED",
"StatusTs": "2024-07-02 03:38:31 -04:00",
"Info": null
},
"OnlineAccess": {
"Status": "CREATED",
"Email": "mark@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": "f808f471-053d-4777-b8f7-a52a8c4f49ea",
"BusinessId": "f87e6f65-b036-4cad-9c20-a03200d9a1c7",
"PayerRef": "RN123",
"Form5498Type": "5498SA",
"Form5498SARecords": {
"SuccessRecords": [
{
"SequenceId": "1",
"RecordId": "f474e884-8db6-4eaa-95ba-522bf5ae2c1f",
"RecipientId": "9b0beedf-c980-404b-9c33-1007f5ff943c",
"PayeeRef": "Payee001",
"AccountNum": "20241520058563079953",
"FederalReturn": {
"Status": "CREATED",
"StatusTs": "2024-07-02 03:38:31 -04:00",
"Info": null,
"Errors": null
},
"Postal": {
"Status": "CREATED",
"StatusTs": "2024-07-02 03:38:31 -04:00",
"Info": null
},
"OnlineAccess": {
"Status": "CREATED",
"Email": "mark@sample.com",
"Info": null
},
"ScheduleFiling": null
}
],
"ErrorRecords": [
{
"SequenceId": null,
"RecordId": "f87e6f65-b036-4cad-9c20-a03200d9a1c7",
"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."
}
]
}
Bad Request Response - You'll get the below response when your API requests contain any validation errors.
{
"StatusCode": 400,
"StatusName": "BadRequest",
"StatusMessage": "Validation error has occurred",
"SubmissionId": null,
"BusinessId": null,
"PayerRef": null,
"Form5498Type": "5498SA",
"Form5498SARecords": null,
"Errors": [
{
"Id": "F00-100146",
"Name": "Submission Id",
"Message": "Submission Id is invalid"
}
]
}