Skip to main content
Version: 1.7.3

Transmit

POST Form944/Transmit 

Request Body

FieldTypeDescription
SubmissionIdGuidUnique identifier of a submission
RecordIdsGuid[]List of record Ids to be transmitted.

Request JSON

{
"SubmissionId": "71454e6b-fb3e-487a-9582-688214f03fb8",
"RecordIds": [
"ed5279fc-7325-4438-80c2-20388b39d842"
]
}

Response Body

FieldTypeDescription
StatusCodenumberReturns the HTTP status codes like 200,300 etc.
StatusNamestringName of the status code.
StatusMessagestringDetailed status message.
SubmissionIdGuidUnique identifier of a submission.
Form944RecordsobjectPulls the Form 944 records with Success and Error statuses.
    SuccessRecordsobject[]It will show the detailed information about the success status of Form 944 Records.
        SequenceIdstringA unique number given by an inbound application to identify failed records.
        RecordIdGuidUnique identifier of a record.
        RecordStatusstringReturns the status of the records.
        CreatedTsstringDate and time of return created.
        UpdatedTsstringDate and time of return updated.
    ErrorRecordsobject[]It will show the detailed information about the error status of Form 944 Records.
        RecordIdGuidUnique identifier of a record.
        SequenceIdstringA unique number given by an inbound application to identify failed records.
        Errorsobject[]Shows detailed error information.
            IdstringReturns the validation error id.
            NamestringName of the validation error.
            MessagestringDescription of the validation error.
Errorsobject[]Shows detailed error information.
    IdstringReturns the validation error code.
    NamestringName of the validation error.
    MessagestringDescription 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": "71454e6b-fb3e-487a-9582-688214f03fb8",
"Form944Records": {
"SuccessRecords": [
{
"SequenceId": "001",
"RecordId": "ed5279fc-7325-4438-80c2-20388b39d842",
"RecordStatus": "Transmitted",
"CreatedTs": "2023-10-03 03:39:06 -04:00",
"UpdatedTs": "2023-10-03 03:39:49 -04:00"
}
],
"ErrorRecords": null
},
"Errors": null
}