Validate
Executes business and data validation checks for the 1099-LTC returns already created in API. Use the Submission ID and Record IDs of the return to validate.
GET Form1099LTC/Validate
Request Params
Field | Type | Description |
---|---|---|
SubmissionId | Guid | Unique identifier of a submission |
RecordIds | Guid[] | An unique identifier generated by TaxBandits when a 1099-LTC return is created. Mention the 1099-LTC return's Record ID that you want to Validate. |
Request Params
Provide the SubmissionId and RecordId to validate the 1099-LTC return.
"Form1099LTC/Validate?SubmissionId=932d2691-5e8f-45db-815a-4a97886773b3&RecordIds=14dc0f70-16c7-48b7-88b0-e1a59315061c"
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-LTC 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. |
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 LTC 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 |
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": "932d2691-5e8f-45db-815a-4a97886773b3",
"Form1099Records": {
"SuccessRecords": [
{
"SequenceId": "1",
"RecordId": "14dc0f70-16c7-48b7-88b0-e1a59315061c",
"Status": "CREATED",
"StatusTs": "2023-05-11 06:43:06 +00:00",
"OnlineAccess": null,
}
],
"ErrorRecords": null
},
"Errors": null
}