Skip to main content
Version: 1.7.0

Transmit

Transmits Online 94X PIN request records to the State after validation.

GET Online94xPINRequest/Transmit  
Run in Postman

Request Params

FieldTypeDescription
SubmissionIdGuidUnique identifier of a submission

Request Params

"Online94xPINRequest/Transmit?SubmissionId=4e157f47-9c26-4a56-8a38-567eebf05163"

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.
Errorsobject[]Shows detailed error information.
    CodestringReturns the validation error code.
    NamestringName of the validation error.
    MessagestringDescription of the validation error.
    TypestringType of validation error.
Online94xPINRecordsobjectPulls the Online 94X PIN request records with Success and Error statuses.
    SuccessRecordsobject[]It will show the detailed information about the success status of Form 941 Records
        SequencestringA 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 941 Records
        SequencestringA unique number given by an inbound application to identify failed records.
        RecordIdGuidUnique identifier of a record
        Errorsobject[]Shows detailed error information.
            CodestringReturns the validation error code.
            NamestringName of the validation error.
            MessagestringDescription of the validation error.
            TypestringType 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": "4e157f47-9c26-4a56-8a38-567eebf05163",
"Errors": null,
"Online94xPINRecords": {
"SuccessRecords": [
{
"Sequence": null,
"RecordId": "162684c0-6d80-4f05-8df2-edc26e2efd90",
"RecordStatus": "Transmitted",
"CreatedTs": "2019-08-02 04:08:20 -04:00",
"UpdatedTs": "2019-08-02 04:10:58 -04:00"
}
],
"ErrorRecords": null
}
}