Skip to main content
Version: 1.7.1

Transmit

Transmit API Endpoint is used to “E-File” the Tax return with the SSA/State Agencies. This endpoint applies the same data validation checks and business rules as CREATE and VALIDATE endpoints. This endpoint can not be called without calling the CREATE endpoint as this endpoint will not create the Tax Return. Once “Transmitted”, based on the options selected, the tax return will be E-Filed with the Federal and/or state agencies and also will be postal mailed to the employees.

POST FormW2/Transmit 
Run in Postman

Request Body

FieldTypeDescription
SubmissionIdGuidUnique identifier of a submission
RecordIdsGuid[]An unique identifier generated by TaxBandits when a W2 return is created. Mention the W2 return's Record ID that you want to transmit.

Request JSON

{
"SubmissionId": "ef869fda-5562-41c8-b0d2-b61ef19a2f5a",
"RecordIds": [
"566e1623-3c07-4d15-9fcc-00cad9a3a5d5"
]
}

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
FormW2RecordsobjectPulls the Form W-2 records with Success and Error statuses
    SuccessRecordsobject[]It will show the detailed information about the success status of Form W2 Records
        SequenceIdstringAn unique reference ID for the submission that can be used to identify a particular record. The Sequence ID will be returned in the Response for your reference.
        RecordIdGuidUnique identifier of a record
        StatusstringReturns the status of the records.
        StatusTsstringDate and time of return created.
        StateReturnsobject[]Returns the state code and return status.
            StateCodestringReturns the code of the state.
            RecordStatusstringReturns the status of the records.
        PostalobjectReturns the status and StatusTs of postal mailing service for Form W2.
            StatusstringReturns the status of postal order.
            StatusTsstringReturns the date and time of the postal order created.
            InfostringReturns the information about Postal mailing service.
        OnlineAccessobjectReturns the Email address for whom the online access to be given and Status of online access.
            StatusstringReturns status of online access for Form W2 return.
            EmailstringEmail address for whom the online access to be given.
            InfostringInformation about the online access service.
    ErrorRecordsobject[]It will show the detailed information about the error status of Form W2 Records.
        RecordIdGuidUnique identifier of a record
        SequenceIdstringAn unique reference ID for the submission that can be used to identify a particular record. The Sequence ID will be returned in the Response for your reference.
        RejectedBystringReturns the information of who rejected the return.
        Errorsobject[]Shows detailed error information
            IdstringReturns the validation error id
            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": "ef869fda-5562-41c8-b0d2-b61ef19a2f5a",
"FormW2Records": {
"SuccessRecords": [
{
"SequenceId": "001",
"RecordId": "566e1623-3c07-4d15-9fcc-00cad9a3a5d5",
"Status": "Transmitted",
"StatusTs": "2021-08-06 10:32:38 -04:00",
"StateReturns": [
{
"StateCode": "IN",
"RecordStatus": "Transmitted"
},
{
"StateCode": "VT",
"RecordStatus": "Transmitted"
},
{
"StateCode": "PA",
"RecordStatus": "Transmitted"
},
{
"StateCode": "KS",
"RecordStatus": "Transmitted"
}
],
"OnlineAccess":null,
"Postal":null
}
],
"ErrorRecords": null
},
"Errors": null
}