Validate
GET Form944/Validate
Request Params
Field | Type | Description |
---|---|---|
SubmissionId | Guid | Unique identifier of a submission |
Request Params
"Form944/validate?SubmissionId=496570cd-e218-4f91-83e6-1549ea8ce525"
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. |
Form944Records | object | Pulls the Form 941 records with Success and Error statuses. |
SuccessRecords | object[] | It will show the detailed information about the success status of Form 944 Records. |
SequenceId | string | A unique number given by an inbound application to identify failed records. |
RecordId | Guid | Unique identifier of a record. |
RecordStatus | string | Returns the status of the records. |
CreatedTs | string | Date and time of return created. |
UpdatedTs | string | Date and time of return updated. |
ErrorRecords | object[] | It will show the detailed information about the error status of Form 944 Records. |
RecordId | Guid | Unique identifier of a record. |
SequenceId | string | A unique number given by an inbound application to identify failed records. |
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": "496570cd-e218-4f91-83e6-1549ea8ce525",
"Form944Records": {
"SuccessRecords": [
{
"SequenceId": "001",
"RecordId": "7d9a60e8-e6d6-4c1c-9daf-0575f5b3fb69",
"RecordStatus": "Created",
"CreatedTs": "2023-10-03 03:00:02 -04:00",
"UpdatedTs": "2023-10-03 03:16:49 -04:00"
}
],
"ErrorRecords": null
},
"Errors": null
}