Transmit
Transmits the Form W2-G return to the IRS. You can Transmit a return successfully only if there are no validation errors in the return.
POST FormW2G/Transmit
Request Body
Field | Type | Description |
---|---|---|
SubmissionId | Guid | A unique identifier generated by TaxBandits when a W2-G return is created. Mention the W2-G return's Submission ID that you want to transmit. |
RecordIds | Guid[] | A unique identifier generated by TaxBandits when a W2-G return is created. Mention the W2-G return's Record ID that you want to transmit. |
Request JSON
{
"SubmissionId": "05c4cfa0-aac5-491c-b5c3-95630933d3e7",
"RecordIds": [
"1ece3ab0-381e-401d-81eb-93f500f9b493"
]
}
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 |
FormW2GRecords | object | Pulls the Form W2-G records with Success and Error statuses |
SuccessRecords | object[] | It will show the detailed information about the success status of Form W2 G Records |
SequenceId | string | A 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 the Return Transmission |
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 W2G. |
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 W2G return. |
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 G Records. |
SequenceId | string | A 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 |
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 |
Response JSON
Success Response - This is a sample response for successful API requests.
{
"StatusCode": 200,
"StatusName": "Ok",
"StatusMessage": "Successful API call",
"SubmissionId": "05c4cfa0-aac5-491c-b5c3-95630933d3e7",
"FormW2GRecords": {
"SuccessRecords": [
{
"SequenceId": "1",
"RecordId": "1ece3ab0-381e-401d-81eb-93f500f9b493",
"Status": "Transmitted",
"StatusTs": "2022-05-06 08:02:14 -04:00",
"StateReturns": null,
"OnlineAccess": null,
"Postal":null
}
],
"ErrorRecords": null
},
"Errors": null
}