Transmit
POST Form1099OID/Transmit
Request Body
Field | Type | Description |
---|---|---|
SubmissionId | Guid | A unique identifier generated by TaxBandits when a 1099-OID return is created. Mention the 1099-OID return's Submission ID that you want to transmit. |
RecordIds | Guid[] | An unique identifier generated by TaxBandits when a 1099-OID return is created. Mention the 1099-OID return's Record ID that you want to transmit. |
Request JSON
{
"SubmissionId": "932d2691-5e8f-45db-815a-4a97886773b3",
"RecordIds": [
"14dc0f70-16c7-48b7-88b0-e1a59315061c"
]
}
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 |
Form1099Records | object | Pulls the Form 1099-OID records with Success and Error statuses |
SuccessRecords | object[] | It will show the detailed information about the success status of Form 1099 OID 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 1099-OID. |
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 1099-OID 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 1099-OID 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": "932d2691-5e8f-45db-815a-4a97886773b3",
"Form1099Records": {
"SuccessRecords": [
{
"SequenceId": "1",
"RecordId": "14dc0f70-16c7-48b7-88b0-e1a59315061c",
"Status": "Transmitted",
"StatusTs": "2023-05-11 10:51:12 +00:00",
"StateReturns":null,
"Postal":null,
"OnlineAccess": {
"Status": "ORDER_CREATED",
"Email": "sample@bodeem.com",
"Info": "Recipient will receive an email with an unique URL to access their form online"
}
}
],
"ErrorRecords": null
}
}