Status
GET Form1099SCorrection/Status
Request Params
Field | Type | Description |
---|---|---|
SubmissionId | Guid | Unique identifier of a submission |
RecordIds | Guid[] | An unique identifier generated by TaxBandits when a 1099 S return is created. Mention the Form 1099 S return's Record ID that you want to Get. |
Request Params
- Sample 1
- Sample 2
Get status with only the SubmissionID
Form1099SCorrection/Status?SubmissionId=9d71ae45-df5f-49f7-86f8-e88f54132fa1&RecordIds=01132f6d-ef4a-4014-817e-94a5a19bd52b
Get status with SubmissionID and 2 RecordIDs
Form1099SCorrection/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. |
Form1099Type | string | Denotes the type of 1099 form. |
Form1099Records | object | PullsForm 1099 S correction records with Success and Error statuses |
SuccessRecords | object[] | It will show the detailed information about the success status ofForm 1099 S correction 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. |
PrevReportedRecordId | Guid | Returns the PrevReportedRecordId given in the Request. |
RecordId | Guid | An unique identifier generated by TaxBandits when a 1099 S correction return is created. |
RecipientId | Guid | An unique identifier generated by TaxBandits for a Recipient when a 1099 S correction 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. |
Status | string | Returns the record status. |
StatusTs | string | Returns date and time of return created. |
Info | string | Returns information about the Federal Filing service. |
StateReturns | object[] | Returns collection of state returns information |
Postal | object | Returns the status and StatusTs of postal mailing service forForm 1099 S correction. |
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 1099 S correction return. |
string | Email address for whom the online access to be given. | |
Info | string | Information about the online access service. |
ErrorRecords | object[] | It will show the detailed information about the error status of Form 1099 S correction 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": "386548ab-5f72-44cc-80ff-58f344a403fa",
"BusinessId": "d5c7f8a1-a23c-4428-a503-5707ce6c056c",
"Form1099Type": "SCorrection",
"Form1099Records": {
"SuccessRecords": [
{
"SequenceId": "001",
"PrevReportedRecordId": "94f30054-e062-49a4-8534-a1756f16702b",
"RecordId": "4b6111d5-e592-4b50-ae3b-ee1cccf01c89",
"RecipientId": "f64381b9-d1c0-4dff-94bf-93fed6cd6cff",
"FederalReturn": {
"Status": "CREATED",
"StatusTs": "2024-01-11 07:13:27 -05:00",
"Info": null,
"Errors": null
},
"Postal": {
"Status": "CREATED",
"StatusTs": "2024-01-11 07:13:27 -05:00",
"Info": null
},
"OnlineAccess": {
"Status": "NA",
"Email": null,
"Info": "This Service will be available soon"
}
}
],
"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": "14a3063a-7ed1-44d6-86f9-0c6f478b9412",
"BusinessId": "93265b4e-b329-44e2-81c2-b81ff008527a",
"PayerRef": null,
"Form1099Type": "SCorrection",
"Form1099Records": {
"SuccessRecords": [
{
"SequenceId": "1",
"RecordId": "e1c6ea37-6388-49ff-baf7-ebe763f69163",
"RecipientId": "c3bf39ce-e01d-4e20-84b9-b9aa586f2cd3",
"FederalReturn": {
"Status": "ACCEPTED",
"StatusTs": "2024-05-31 08:32:19 -04:00",
"Info": null,
"Errors": null
},
"Postal": {
"Status": "CREATED",
"StatusTs": "2024-05-31 08:32:19 -04:00",
"Info": null
},
"OnlineAccess": null,
"ScheduleFiling": {
"ScheduledOn": null,
"Info": "This service will be available soon"
}
}
],
"ErrorRecords": [
{
"SequenceId": null,
"RecordId": "9f098c31-a669-439c-b3f3-ca952b1219c1",
"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": "9d71ae45-df5f-49f7-86f8-e88f54132fa1",
"BusinessId": null,
"PayerRef": null,
"Form1099Type": null,
"Form1099Records": null,
"Errors": [
{
"Id": "F00-100249",
"Name": "NotFound",
"Message": "No records found"
}]
}