Skip to main content
Version: 1.7.3

Transmit

Transmit

Use this endpoint to transmit the withholding forms to the corresponding state agency.

Key Points

  • Once a form is transmitted, it cannot be edited or deleted.
  • To transmit all returns under a Submission, provide only the SubmissionId in the request.
  • To transmit specific returns within a Submission, provide the SubmissionId along with the RecordIds of the returns.
POST StateFilings/Transmit 

Request Body

FieldTypeDescription
BusinessIdGuidUnique identifier of a business
SubmissionIdGuidUnique identifier of a submission
RecordIdsGuid[]An unique identifier generated by TaxBandits when a withholding or UI return is created. Mention the return's Record IDs that you want to Transmit.

Response Body

FieldTypeDescription
SubmissionIdGuidUnique identifier of a submission
SuccessRecordsobject[]It will show the detailed information about the success status of withholding or UI Records
BusinessIdGuidReturns the unique Business ID for the Business. It can be used in future to refer the same business
PayerRefstringA unique identifier for each payer completing their information. This identifier can be used in future references of the payer in the API.
SequenceIdstringA unique number given by an inbound application to identify particular records. The Sequence ID will be returned in the Response for your reference.
RecordIdGuidUnique identifier of a record
FormTypestringDenotes the type of withholding form
StatusstringReturns the status of the records.
StatusTsstringDate and Time of the Return Transmission
InfostringInformation about the state filing returns
Errorsobject[]Shows detailed error information
IdstringReturns the validation error Id
NamestringName of the validation error
MessagestringDescription of the validation error
ErrorRecordsobject[]It will show the detailed information about the error status of withholding or UI Records.
SequenceIdstringA unique number given by an inbound application to identify error records. The Sequence ID will be returned in the Response for your reference.
RecordIdGuidUnique identifier of a record
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 Id
NamestringName of the validation error
MessagestringDescription of the validation error

Request JSON

{
"BusinessId": "k8c0b155-7856-4f9d-c7nb-mnv7a0f69c7r",
"SubmissionId": "c59ed08e-5330-4a1a-b3ea-37879516bbdf",
"RecordIds": [
"f5c0b155-7261-4f9d-b0bc-cad7a0f69d2e"
]
}

Response JSON

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

{
"StatusCode": "200",
"StatusName": "Ok",
"StatusMessage": "Successful API call",
"SuccessRecords": [
{
"BusinessId": "d2100525-3a85-4b33-8fb4-3f7682944ee1",
"PayerRef": null,
"SequenceId": "001",
"RecordId": "01993c45-e804-75cc-b9ff-908f41dbe62f",
"FormType": "SC1605",
"Status": "TRANSMITTED",
"StatusTs": "2025-09-12 00:54:19 -04:00",
"Info": null,
"Errors": null
},
{
"BusinessId": "01e8159f-dace-4f65-adaf-57d406be4e24",
"PayerRef": null,
"SequenceId": "002",
"RecordId": "01993c45-eb89-7084-a20f-4ec9acf05faf",
"FormType": "SC1606",
"Status": "TRANSMITTED",
"StatusTs": "2025-09-12 00:54:19 -04:00",
"Info": null,
"Errors": null
}
],
"SubmissionId": "01993c45-e77e-7383-823a-d13273fd717c",
"ErrorRecords": null,
"Errors": null
}