Validate
Validates the return against IRS business rules and field specifications. You can Transmit a return successfully only if there no errors after validating the return.
GET Form1099OIDCorrection/Validate
Request Params
Field | Type | Description |
---|---|---|
SubmissionId | Guid | Unique identifier of a submission |
RecordIds | Guid[] | An unique identifier generated by TaxBandits when a 1099-OID return is created. Mention the 1099-OID correction return's Record ID that you want to Validate. |
Request Params
"Form1099OIDCorrection/validate?SubmissionId=386548ab-5f72-44cc-80ff-58f344a403fa&RecordId=4b6111d5-e592-4b50-ae3b-ee1cccf01c89"
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 |
Form1099Records | object | Pulls the Form 1099 OID correction records with Success and Error statuses |
SuccessRecords | object[] | It will show the detailed information about the success status of Form 1099 OID 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 | Record ID of the returns that were successfully validated. |
Status | string | Returns the status of the records. |
StatusTs | string | Date and time of return created. |
StateReturns | string | Returns collection of state returns information |
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 MISC 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 OID 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
Success Response - This is a sample response for successful API requests.
{
"StatusCode": 200,
"StatusName": "Ok",
"StatusMessage": "Successful API call",
"SubmissionId": "c58cb841-1cea-4848-b2a6-c731559a5147",
"Form1099Records": {
"SuccessRecords": [
{
"SequenceId": "001",
"RecordId": "71844168-d0ef-4b75-8a93-0a0adf17d1a5",
"Status": "CREATED",
"StatusTs": "2023-12-18 08:29:16 -05:00",
"StateReturns": null,
"OnlineAccess": null
}
],
"ErrorRecords": null
},
"Errors": null
}