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 

Request Body

Field	Type	Description
SubmissionId	Guid	Unique identifier of a submission
RecordIds	Guid[]	An unique identifier generated by TaxBandits when a W2 return is created. Mention the W2 return's Record ID that you want to transmit.

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
FormW2Records	object	Pulls the Form W-2 records with Success and Error statuses
SuccessRecords	object[]	It will show the detailed information about the success status of Form W2 Records
SequenceId	string	An 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.
RecordId	Guid	Unique identifier of a record
Status	string	Returns the status of the records.
StatusTs	string	Date and time of return created.
StateReturns	object[]	Returns the state code and return status.
StateCode	string	Returns the code of the state.
RecordStatus	string	Returns the status of the records.
Postal	object	Returns the status and StatusTs of postal mailing service for Form W2.
Status	string	Returns the status of postal order.
StatusTs	string	Returns the date and time of the postal order created.
Info	string	Returns the information about Postal mailing service.
OnlineAccess	object	Returns the Email address for whom the online access to be given and Status of online access.
Status	string	Returns status of online access for Form W2 return.
Email	string	Email address for whom the online access to be given.
Info	string	Information about the online access service.
ErrorRecords	object[]	It will show the detailed information about the error status of Form W2 Records.
RecordId	Guid	Unique identifier of a record
SequenceId	string	An 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.
RejectedBy	string	Returns the information of who rejected the return.
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

Payload

Request Json

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

Response Json

Response	Description	Action
200	Success Response - This is a sample response for successful API requests.

Response: 200

{
 "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": {
           "Status": "ORDER_CREATED",
           "Email": "sample@bodeem.com",
           "Info": "Recipient will receive an email with an unique URL to access their form online"
         },
         "Postal": {
           "Status": "RECEIVED",
            "StatusTs": "2023-08-09 06:09:28 -04:00",
            "Info": null
         }
     }
   ],
   "ErrorRecords": null
 },
 "Errors": null
}

Node.js

Python

Java

.NET C#