Status
This method will return the current status of Form 1099 for a particular submission or for a particular recipient.
Federal
- CREATED - Form 1099 has been created and has not yet been transmitted.
- TRANSMITTED - Form 1099 has been transmitted by the user.
- SENT TO AGENCY - Form 1099 has been sent to the IRS, and we are waiting for the result from the IRS.
- ACCEPTED - Form 1099 is accepted by the IRS.
- REJECTED - Form 1099 is rejected by the IRS due to some errors. The user must correct the errors and retransmit the forms.
State
- CREATED - Form 1099 (State) has been created and has not yet been transmitted
- NOTCREATED - Form 1099 (State) has not been created since state filing hasn’t been opted.
- TRANSMITTED - Form 1099 (State) has been transmitted by the user.
- SENT TO AGENCY - Form 1099 (State) has been sent to the state DOR, and awaiting result.
- ACCEPTED - Form 1099 is accepted by the state DOR.
- REJECTED - Form 1099 is rejected by the state DOR.
Postal Mailing
- CREATED - Postal mailing opted for the 1099 Forms.
- SENT - Form copies are mailed to the recipients.
- RECEIVED - Form copies are received by the recipients.
- NOTCREATED - Postal mailing wasn't opted. To opt for postal mailing, the 'IsPostalMailing' in the submission manifest of the Create request must be set to TRUE.
Online Access
- CREATED - Online Access opted for the 1099 forms, and the secure link to download form copies forms will be emailed to the recipients as soon as the form is transmitted.
- ORDER_RECIEVED - An order for online access has been received, and the email will be sent to the recipient soon.
- EMAIL_SENT - A secure link to download form copies has been emailed to the recipients.
- DOWNLOADED_FORM - The recipient successfully viewed and downloaded the form.
- VIEWED_FORM - The Recipient has successfully viewed the form.
GET Form1099G/Status
Request Params
Field | Type | Description |
---|---|---|
SubmissionId | Guid | Unique identifier of a submission |
RecordIds | Guid[] | List of record Ids to get the status of Form 1099-G. |
Request Params
- Sample 1
- Sample 2
Get status with only the SubmissionID
Form1099G/Status?SubmissionId=cea8be7c-1c1d-4bf7-ba68-509f3e07d1ef&RecordIds=e1ba8410-2e95-4c9d-9838-615197377c79
Get status with SubmissionID and 2 RecordIDs
Form1099G/Status?SubmissionId=cea8be7c-1c1d-4bf7-ba68-509f3e07d1ef&RecordIds=e1ba8410-2e95-4c9d-9838-615197377c79,c34ac3c9-5f41-4dd5-887e-7fdc215eae90
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 |
BusinessId | Guid | Unique identifier of a Business. |
PayerRef | string | Unique identifier of the payer. |
Form1099Type | string | Denotes the type of 1099 form. |
Form1099Records | object | Pulls Form 1099-G records with Success and Error statuses |
SuccessRecords | object[] | It will show the detailed information about the success status of Form 1099-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 | A unique identifier generated by TaxBandits when a 1099-G return is created. |
RecipientId | Guid | A unique identifier generated by TaxBandits for a Recipient when a 1099-G return is created. You can use this id for your future reference to update. |
FederalReturn | object | Returns the record status and StatusTs of federal return. |
Status | string | Returns the record status. |
StatusTs | string | Returns date and time of return created. |
Info | string | Returns information about the Federal Filing service. |
StateReturns | object[] | Returns collection of state returns information |
StateCd | string | Returns the state code of the state which the return filed. |
Status | string | Returns the record status of the state return. |
StatusTs | string | Date and time of the return created. |
Info | string | Returns the information about the state for which we are not state filing. |
Errors | object[] | Shows error information of state returns of Form 1099-G |
Id | string | Returns the validation error Id. |
Name | string | Name of the validation error. |
Message | string | Description of the validation error. |
Postal | object | Returns the status and StatusTs of postal mailing service for Form 1099-G. |
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-G return. |
string | Email address for whom the online access to be given. | |
Info | string | Information about the online access service. |
ScheduleFiling | object | Returns the date of the schedule filing. |
ScheduledOn | string | Date of the schedule filing to know when the return to be filed to the IRS. |
Info | string | Information about Schedule Filing service. |
ErrorRecords | object[] | It will show the detailed information about the error status of Form 1099-G 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 |
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 |
Response JSON
- 200
- 300
- 404
Success Response - This is a sample response for successful API requests.
{
"StatusCode": 200,
"StatusName": "Ok",
"StatusMessage": "Successful API call",
"SubmissionId": "cea8be7c-1c1d-4bf7-ba68-509f3e07d1ef",
"BusinessId": "bfe7ee55-835c-4fe1-a2b7-1e7c3027598b",
"PayerRef": "Snow123",
"Form1099Type": "G",
"Form1099Records": {
"SuccessRecords": [
{
"SequenceId": "1",
"RecordId": "e1ba8410-2e95-4c9d-9838-615197377c79",
"RecipientId": "c34ac3c9-5f41-4dd5-887e-7fdc215eae90",
"FederalReturn": {
"Status": "CREATED",
"StatusTs": "2024-06-13 01:32:31 -04:00",
"Info": null,
"Errors": null
},
"StateReturns": null,
"Postal": null,
"OnlineAccess": {
"Status": "CREATED",
"Email": "shawn@sample.com",
"Info": null
},
"ScheduleFiling": {
"ScheduledOn": null,
"Info": "This service will be available soon"
}
}
],
"ErrorRecords": null
},
"Errors": null
}
Multi-status Response - You'll get the below response when multiple statuses are included.
{
"StatusCode": 300,
"StatusName": "MultiStatus",
"StatusMessage": "Multiple statuses are available for the request.",
"SubmissionId": "cea8be7c-1c1d-4bf7-ba68-509f3e07d1ef",
"BusinessId": "bfe7ee55-835c-4fe1-a2b7-1e7c3027598b",
"PayerRef": "Snow123",
"Form1099Type": "G",
"Form1099Records": {
"SuccessRecords": [
{
"SequenceId": "1",
"RecordId": "e1ba8410-2e95-4c9d-9838-615197377c79",
"RecipientId": "c34ac3c9-5f41-4dd5-887e-7fdc215eae90",
"FederalReturn": {
"Status": "CREATED",
"StatusTs": "2024-06-13 01:32:31 -04:00",
"Info": null,
"Errors": null
},
"StateReturns": null,
"Postal": null,
"OnlineAccess": {
"Status": "CREATED",
"Email": "shawn@sample.com",
"Info": null
},
"ScheduleFiling": {
"ScheduledOn": null,
"Info": "This service will be available soon"
}
}
],
"ErrorRecords": [
{
"SequenceId": null,
"RecordId": "c34ac3c9-5f41-4dd5-887e-7fdc215eae90",
"Errors": [
{
"Id": "ERR-INVRECORDID-001",
"Name": "RECORDID",
"Message": "Invalid Record Id"
}
]
}
]
},
"Errors": [
{
"Id": "ERR-RECS-001",
"Name": "Error Records",
"Message": "Some of the records are errored. Please read the Error Records for more details"
}
]
}
Not Found Response - You'll get the below response if your API request contains a record that's not found in our database.
{
"StatusCode": 404,
"StatusName": "NotFound",
"StatusMessage": "The resource you have specified cannot be found",
"SubmissionId": "9d71ae45-df5f-49f7-86f8-e88f54132fa1",
"BusinessId": null,
"PayerRef": null,
"Form1099Type": null,
"Form1099Records": null,
"Errors": [
{
"Id": "F00-100249",
"Name": "NotFound",
"Message": "No records found"
}]
}