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.
- ACCEPTED WITH ERRORS - The IRS has accepted the return with some validation errors, and a correction must be filed as soon as possible with the correct information.
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 Form1099PATR/Status 
Request Params
| Field | Type | Description |
|---|---|---|
| SubmissionId | Guid | Unique identifier of a submission |
| RecordIds | Guid[] | Number of record Ids to get status. |
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-PATR records with Success and Error statuses |
| SuccessRecords | object[] | It will show detailed information about the success status of Form 1099-PATR 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-PATR return is created. |
| RecipientId | Guid | A Unique identifier generated by TaxBandits for a Recipient when a 1099-PATR return is created. You can use this id for your future reference to Update. |
| PayeeRef | string | A unique identifier for each payee completing their information. |
| AccountNum | string | Account number of Payer having multiple accounts for a recipient for whom more than one Form 1099-PATR is filed. Size Range: 4..20 Note: If the account number on the return you file is the same as any previously filed return, TaxBandits will append 3 random numbers at the end of the account number. |
| 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 1099-PATR. |
| 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-PATR 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-PATR 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 |
| 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 Params
- Node.js
- Python
- Java
- .NET C#
Request Json
| Sample | Description | Action |
|---|---|---|
| Sample 1 | Get status with only the SubmissionID | |
| Sample 2 | Get status with SubmissionID and 2 RecordIDs |
Sample 1
"Form1099PATR/Status?SubmissionId=9d71ae45-df5f-49f7-86f8-e88f54132fa1&RecordIds=01132f6d-ef4a-4014-817e-94a5a19bd52b"
Response Json
| Response | Description | Action |
|---|---|---|
| 200 | Success Response - This is a sample response for successful API requests. | |
| 300 | Multi-status Response - You'll get the below response when multiple statuses are included. | |
| 404 | Not Found Response - You'll get the below response if your API request contains a record that's not found in our database. |
Response: 200
{
"StatusCode": 200,
"StatusName": "Ok",
"StatusMessage": "Successful API call",
"SubmissionId": "8f6a521b-afd7-473b-b4d9-838b21622de1",
"BusinessId": "23523b64-3365-43f8-ab80-d6848573e230",
"PayerRef": "Snow1234",
"Form1099Type": "PATR",
"Form1099Records": {
"SuccessRecords": [
{
"SequenceId": "1",
"RecordId": "d412363d-655a-44b3-bf4b-63cc461529b7",
"RecipientId": "83bca0b4-030e-492b-b068-cdfca5c1077e",
"PayeeRef": "Payee001",
"AccountNum":"20241520040564049666",
"FederalReturn": {
"Status": "CREATED",
"StatusTs": "2024-06-27 05:18:40 -04:00",
"Info": null,
"Errors": null
},
"Postal": null,
"OnlineAccess": {
"Status": "CREATED",
"Email": "shawn@sample.com",
"Info": null
},
"ScheduleFiling": null
},
{
"SequenceId": "2",
"RecordId": "681d103b-e396-4c02-bf62-a7470d60b2f4",
"RecipientId": "83bca0b4-030e-492b-b068-cdfca5c1077e",
"PayeeRef": "Payee002",
"AccountNum":"20241520040564048466",
"FederalReturn": {
"Status": "TRANSMITTED",
"StatusTs": "2024-06-27 05:26:19 -04:00",
"Info": null,
"Errors": null
},
"Postal": null,
"OnlineAccess": {
"Status": "EMAIL_SENT",
"Email": "shawn@sample.com",
"Info": null
},
"ScheduleFiling": null
},
{
"SequenceId": "3",
"RecordId": "b8979d78-465e-4cec-9fa6-7f7ec0b455d3",
"RecipientId": "83bca0b4-030e-492b-b068-cdfca5c1077e",
"PayeeRef": "Payee003",
"AccountNum":"20241520040564129666",
"FederalReturn": {
"Status": "SENT TO AGENCY",
"StatusTs": "2024-06-27 05:27:20 -04:00",
"Info": null,
"Errors": null
},
"Postal": null,
"OnlineAccess": {
"Status": "EMAIL_SENT",
"Email": "shawn@sample.com",
"Info": null
},
"ScheduleFiling": null
},
{
"SequenceId": "4",
"RecordId": "30219e6b-4123-483c-9708-0cfa5e4d2526",
"RecipientId": "83bca0b4-030e-492b-b068-cdfca5c1077e",
"PayeeRef": "Payee004",
"AccountNum":"20241520040564049516",
"FederalReturn": {
"Status": "ACCEPTED",
"StatusTs": "2024-06-27 05:27:32 -04:00",
"Info": null,
"Errors": null
},
"Postal": null,
"OnlineAccess": {
"Status": "EMAIL_SENT",
"Email": "shawn@sample.com",
"Info": null
},
"ScheduleFiling": null
},
{
"SequenceId": "5",
"RecordId": "31126d9a-84fc-4589-8187-3ea0f236582f",
"RecipientId": "83bca0b4-030e-492b-b068-cdfca5c1077e",
"PayeeRef": "Payee005",
"AccountNum":"20241520010564049666",
"FederalReturn": {
"Status": "REJECTED",
"StatusTs": "2024-06-27 05:27:31 -04:00",
"Info": null,
"Errors": [
{
"Id": "F98-FED-10001",
"Name": "Rejected Record",
"Message": "Sample Error Message"
}
]
},
"Postal": null,
"OnlineAccess": {
"Status": "EMAIL_SENT",
"Email": "shawn@sample.com",
"Info": null
},
"ScheduleFiling": null
}
],
"ErrorRecords": null
},
"Errors": null
}