Transmit
Transmits 940 forms to the IRS after validation.
POST Form940/Transmit
Request Body
Field | Type | Description |
---|---|---|
SubmissionId | Guid | Unique identifier of a submission. |
RecordIds | Guid[] | List of record Ids to be transmitted. |
Request JSON
{
"SubmissionId": "7f9cb1ab-f90b-4358-ae5f-acfe19617d96",
"RecordIds": [
"22af7b4b-42f2-4e68-a9ac-743d2fd76636"
]
}
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. |
Form940Records | object | Pulls the Form 940 records with Success and Error statuses. |
SuccessRecords | object[] | It will show the detailed information about the success status of Form 940 Records. |
Sequence | 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 940 Records |
RecordId | Guid | Unique identifier of a record. |
Sequence | string | A unique number given by an inbound application to identify failed records. |
Errors | object[] | Shows detailed error information. |
Code | string | Returns the validation error code. |
Name | string | Name of the validation error. |
Message | string | Description of the validation error. |
Type | string | Type of validation error. |
Response JSON
Success Response - This is a sample response for successful API requests.
{
"StatusCode": 200,
"StatusName": "Ok",
"StatusMessage": "Successful API call",
"SubmissionId": "7f9cb1ab-f90b-4358-ae5f-acfe19617d96",
"Form940Records": {
"SuccessRecords": [
{
"Sequence": null,
"RecordId": "22af7b4b-42f2-4e68-a9ac-743d2fd76636",
"RecordStatus": "Transmitted",
"CreatedTs": "8/6/2019 1:29:56 AM",
"UpdatedTs": "8/6/2019 1:44:28 AM"
}
],
"ErrorRecords": []
},
"Errors": []
}