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
| Field | Type | Description |
|---|---|---|
| BusinessId | Guid | Unique identifier of a business |
| SubmissionId | Guid | Unique identifier of a submission |
| RecordIds | Guid[] | 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
| Field | Type | Description |
|---|---|---|
| SubmissionId | Guid | Unique identifier of a submission |
| SuccessRecords | object[] | It will show the detailed information about the success status of withholding or UI Records |
| BusinessId | Guid | Returns the unique Business ID for the Business. It can be used in future to refer the same business |
| PayerRef | string | A unique identifier for each payer completing their information. This identifier can be used in future references of the payer in the API. |
| SequenceId | string | A unique number given by an inbound application to identify particular records. The Sequence ID will be returned in the Response for your reference. |
| RecordId | Guid | Unique identifier of a record |
| FormType | string | Denotes the type of withholding form |
| Status | string | Returns the status of the records. |
| StatusTs | string | Date and Time of the Return Transmission |
| Info | string | Information about the state filing returns |
| 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 |
| ErrorRecords | object[] | It will show the detailed information about the error status of withholding or UI Records. |
| SequenceId | string | A unique number given by an inbound application to identify error records. 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 |
| 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 |
Request JSON
{
"BusinessId": "k8c0b155-7856-4f9d-c7nb-mnv7a0f69c7r",
"SubmissionId": "c59ed08e-5330-4a1a-b3ea-37879516bbdf",
"RecordIds": [
"f5c0b155-7261-4f9d-b0bc-cad7a0f69d2e"
]
}
Response JSON
- 200
- 400
- 402
- 401
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
}
Bad Request Response - You'll get the below response when your API requests contain any validation errors.
{
"StatusCode": "400",
"StatusName": "BadRequest",
"StatusMessage": "Validation error has occurred",
"SubmissionId": null,
"SuccessRecords": null,
"ErrorRecords": null,
"Errors": [
{
"Id": "S00-000197",
"Name": "Submission Id",
"Message": "Submission Id is invalid"
}
]
}
{
"StatusCode": "402",
"StatusName": "CreditsNotSufficient",
"StatusMessage": "The Credit in your account is not sufficient to transmit all requested records",
"SubmissionId": null,
"SuccessRecords": null,
"ErrorRecords": null,
"Errors": [
{
"Id": "S00-000194",
"Name": "Insufficient BanditCash",
"Message": "Insufficient Banditcash to transmit the return"
}
]
}
Unauthorized Response - You'll get the below response when your API requests don't contain valid authentication credentials.
{
"StatusCode": 401,
"StatusName": "Unauthorized",
"StatusMessage": "Invalid authorization credentials",
"Errors": [
{
"Id": "AUTH-100018",
"Name": "Authorization",
"Message": "JWT EXPIRED"
}
]
}