Transmit
Transmit
Transmits 941SCHR forms to the IRS after validation.
POST Form941SCHR/Transmit Request Body
| Field | Type | Description |
|---|---|---|
| SubmissionId | Guid | Unique identifier of a submission. |
| RecordIds | Guid[] | List of record Ids to be transmitted. |
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. |
| Form941Records | object | Pulls the Form 941SCHR records with Success and Error statuses |
| SuccessRecords | object[] | It will show the detailed information about the success status of Form 941 Schedule R 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. |
| ClientSuccessRecords | object[] | Client Success Status |
| CSeqId | string | This identifies the sequence on the record sent in the payload. When errors occur we will send the errors attached to particular sequence. Required |
| CRecordId | Guid | Client Record Identifier |
| RecordStatus | string | Return status details like Processing, Created, Accepted, Rejected. |
| CreatedTs | string | Return created date and time |
| UpdatedTs | string | Return updated date and time |
| ErrorRecords | object[] | It will show the detailed information about the error status of Form 941 Schedule R Records |
| SequenceId | string | A unique number given by an inbound application to identify failed records. |
| 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. |
| ClientErrorRecords | object[] | Client Error Status |
| CSeqId | string | This identifies the sequence on the record sent in the payload. When errors occur we will send the errors attached to particular sequence. Required |
| CRecordId | Guid | Client Record Identifier |
| Errors | object[] | It will show the detailed information about the error. |
| Id | string | It will return the validation error id. |
| Name | string | It will return the name of the validation error. |
| Message | string | It will return the detailed message of the validation error. |
| Errors | object[] | Shows detailed error information. |
| Id | string | Returns the validation error code. |
| Name | string | Name of the validation error. |
| Message | string | Description of the validation error. |
Request JSON
{
"SubmissionId": "2a6b1e28-b92b-45d8-b9b8-faf1fd8539d6",
"RecordIds": [
"0db86232-dca7-4ac2-9d31-6d4fb7087909"
]
}
Response JSON
Success Response - This is a sample response for successful API requests.
{
"StatusCode": 200,
"StatusName": "Ok",
"StatusMessage": "Successful API call",
"SubmissionId": "2a6b1e28-b92b-45d8-b9b8-faf1fd8539d6",
"Form941Records": {
"SuccessRecords": [
{
"Sequence": "1",
"RecordId": "0db86232-dca7-4ac2-9d31-6d4fb7087909",
"RecordStatus": "Transmitted",
"CreatedTs": "2022-03-03 05:38:20 -04:00",
"UpdatedTs": "2022-03-03 05:45:45 -04:00"
}
],
"ErrorRecords": null
},
"Errors": null
}