Validate
Validate method will execute business and data validation checks for the 1099-NEC returns already created in API. To validate the returns, use the Submission ID and Record IDs of the particular return to validate.
GET Form1099NEC/Validate
Request Params
Field | Type | Description |
---|---|---|
SubmissionId | Guid | Unique identifier of a submission |
RecordIds | Guid[] | An unique identifier generated by TaxBandits when a 1099-NEC return is created. Mention the 1099-NEC return's Record ID that you want to Validate. |
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-NEC records with Success and Error statuses |
SuccessRecords | object[] | It will show the detailed information about the success status of Form 1099 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 | object[] | Returns collection of state returns information |
StateCd | string | Returns the state code of the state for which the return is filed. |
Status | string | Returns the record status of the state return. |
StatusTs | string | Date and time of the return created. |
Info | string | Returns the information about the state for which we are not supporting state filing. |
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 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 |
- Request Params
- Node.js
- Python
- Java
- .NET C#
Sample | Description | Action |
---|---|---|
Sample 1 | Provide the SubmissionId and RecordId to validate the 1099-NEC return. |
Sample 1
"Form1099NEC/Validate?SubmissionId=9d71ae45-df5f-49f7-86f8-e88f54132fa1&RecordIds=01132f6d-ef4a-4014-817e-94a5a19bd52b,eb39714e-f653-4c4d-a53c-07f24f9a9dj5"
Response Json
Response | Description | Action |
---|---|---|
200 | Success Response - This is a sample response for successful API requests. |
Response: 200
{
"StatusCode": 200,
"StatusName": "Ok",
"StatusMessage": "Successful API call",
"SubmissionId": "9d71ae45-df5f-49f7-86f8-e88f54132fa1",
"Form1099Records": {
"SuccessRecords": [
{
"SequenceId": "1",
"RecordId": "15c3caa6-8402-4548-8713-4fcdd2f7d42d",
"Status": "CREATED",
"StatusTs": "2021-08-05 06:26:16 -04:00",
"StateReturns": null,
"OnlineAccess": null
},
{
"SequenceId": "2",
"RecordId": "eb39714e-f653-4c4d-a53c-07f24f9a9dj5",
"Status": "CREATED",
"StatusTs": "2021-08-05 06:26:16 -04:00",
"StateReturns": null,
"OnlineAccess": null
}
],
"ErrorRecords": null
},
"Errors": null
}