Status
This method will return the current status of Form 1099 for a particular submission or for a particular recipient.
Federal Return Statuses:
-
Created: Form 1099 has been created and not yet transmitted by the user.
-
Transmitted: Form 1099 has been transmitted by the user.
-
Order Received: Form 1099 order is received and waiting in our efile queue.
-
Under Process: Our efile system is processing the Form 1099 which will be sent to the IRS soon.
-
Sent to Agency: Form 1099 has been sent to the SSA and we are waiting for the result from IRS.
-
Accepted: Form 1099 is accepted by the IRS.
-
Rejected: Form 1099 is rejected by the IRS due to some errors. Please correct the errors and retransmit them.
Postal Mailing Statuses:
-
Not Created: Postal Mailing is not opted for the return. IsPostalMailing in the submission manifest must be set as TRUE to enable postal mailing. Postal Mailing cannot be created for recipients with Foreign addresses.
-
Created: Postal Mailing service is opted for the return and it will be sent as soon as the form is transmitted.
-
Order Received: Postal Mailing order has been received and the mails will be sent out soon.
-
Order Sent: Postal Mailing order has been sent and the recipient will receive the copy soon.
GET FormW2G/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 W2-G. |
Request Params
- Sample 1
- Sample 2
Get status with only the SubmissionID
"Formw2G/Status?SubmissionId=1abc3bc8-a3dc-499e-9e28-f25c0c458f32"
Get status with SubmissionID and 2 RecordIDs
"Formw2G/Status?SubmissionId=1abc3bc8-a3dc-499e-9e28-f25c0c458f32&RecordIds=6dbc5de2-1a19-4143-9a2e-1709a5610342"
Response Body
Field | Type | Description |
---|---|---|
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 W-2G records with Success and Error statuses |
SuccessRecords | object[] | It will show the detailed information about the success status of Form W-2G 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 | An unique identifier generated by TaxBandits when a W-2G return is created. |
RecipientId | Guid | An unique identifier generated by TaxBandits for a Recipient when a W-2G 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. |
Postal | object | Returns the status and StatusTs of postal mailing service for Form W-2G. |
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 W-2G 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 W-2G 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": "1abc3bc8-a3dc-499e-9e28-f25c0c458f32",
"BusinessId": "b161f84d-d38e-4d37-a2a4-ec952f8462cb",
"PayerRef": "Pe1234",
"Form1099Type": "W2G",
"Form1099Records": {
"SuccessRecords": [
{
"SequenceId": "1",
"RecordId": "6dbc5de2-1a19-4143-9a2e-1709a5610342",
"RecipientId": "ff406310-e6bd-4538-b1cc-0354bb5c1756",
"FederalReturn": {
"Status": "CREATED",
"StatusTs": "2024-07-02 01:18:04 -04:00",
"Info": null,
"Errors": null
},
"StateReturns": {
"StateCd": "CA",
"Status": "NOTCREATED",
"StatusTs": null,
"Info": "Taxbandits Currently does not support StateFiling for the Form W2G",
"Errors": null
},
"Postal": {
"Status": "CREATED",
"StatusTs": "2024-07-02 01:18:04 -04:00",
"Info": null
},
"OnlineAccess": {
"Status": "CREATED",
"Email": "mark+32@sample.com",
"Info": null
},
"ScheduleFiling": null
}
],
"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": "1abc3bc8-a3dc-499e-9e28-f25c0c458f32",
"BusinessId": "b161f84d-d38e-4d37-a2a4-ec952f8462cb",
"PayerRef": "Pe1234",
"Form1099Type": "W2G",
"Form1099Records": {
"SuccessRecords": [
{
"SequenceId": "1",
"RecordId": "6dbc5de2-1a19-4143-9a2e-1709a5610342",
"RecipientId": "ff406310-e6bd-4538-b1cc-0354bb5c1756",
"FederalReturn": {
"Status": "CREATED",
"StatusTs": "2024-07-02 01:18:04 -04:00",
"Info": null,
"Errors": null
},
"StateReturns": {
"StateCd": "CA",
"Status": "NOTCREATED",
"StatusTs": null,
"Info": "Taxbandits Currently does not support StateFiling for the Form W2G",
"Errors": null
},
"Postal": {
"Status": "CREATED",
"StatusTs": "2024-07-02 01:18:04 -04:00",
"Info": null
},
"OnlineAccess": {
"Status": "CREATED",
"Email": "mark+32@sample.com",
"Info": null
},
"ScheduleFiling": null
}
],
"ErrorRecords": [
{
"SequenceId": null,
"RecordId": "1abc3bc8-a3dc-499e-9e28-f25c0c458f32",
"Errors": [
{
"Id": "F00-100192",
"Name": "RecordId",
"Message": "Invalid RecordId"
}
]
}
]
},
"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": "6dbc5de2-1a19-4143-9a2e-1709a5610342",
"BusinessId": null,
"PayerRef": null,
"Form1099Type": "W2G",
"Form1099Records": null,
"Errors": [
{
"Id": "F68-100029",
"Name": "SubmissionId",
"Message": "SubmissionId is invalid"
}
]
}