Validate
Validate
Executes business and data validation checks for the 1099-G returns already created in API. Use the Submission ID and Record IDs of the return to validate.
GET Form1099G/Validate Request Params
| Field | Type | Description |
|---|---|---|
| SubmissionId | Guid | Unique identifier of a submission |
| RecordsIds | Guid[] | unique identifier generated by TaxBandits when a 1099-G return is created. Mention the 1099-G 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-G records with Success and Error statuses |
| SuccessRecords | object[] | It will show the detailed information about the success status of Form 1099 Records |
| SequenceId | string | A 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 | A 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 |
Payload
Node.js
Python
Java
.NET C#
Request Params
| Sample | Description | Action |
|---|---|---|
| Sample 1 | Provide the SubmissionId and RecordId to validate the 1099-G return. |
Sample 1
"Form1099G/Validate?SubmissionId=0304885f-6cad-45c8-961f-06ee47a7fd07&RecordIds=7e39a894-b7ac-4d65-82d7-11726fa42db3"
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": "0304885f-6cad-45c8-961f-06ee47a7fd07",
"Form1099Records": {
"SuccessRecords": [
{
"SequenceId": "001",
"RecordId": "7e39a894-b7ac-4d65-82d7-11726fa42db3",
"Status": "CREATED",
"StatusTs": "2021-11-24 09:16:18 -05:00",
"StateReturns": null,
"OnlineAccess": null
}
],
"ErrorRecords": null
},
"Errors": null
}