Skip to main content
Version: 1.7.1

Status

This method will return the current status of Form 1099 for a particular submission or for a particular recipient.

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 Form1099PATR/Status
Run in Postman

Request Params

FieldTypeDescription
SubmissionIdGuidUnique identifier of a submission
RecordIdsGuid[]Number of record Ids to get status.

Request Params

Get status with only the SubmissionID

Form1099PATR/Status?SubmissionId=9d71ae45-df5f-49f7-86f8-e88f54132fa1&RecordIds=01132f6d-ef4a-4014-817e-94a5a19bd52b

Response Body

FieldTypeDescription
StatusCodenumberReturns the HTTP status codes like 200,300 etc.
StatusNamestringName of the status code
StatusMessagestringDetailed status message
SubmissionIdGuidUnique identifier of a submission
BusinessIdGuidUnique identifier of a Business.
PayerRefstringUnique identifier of the payer.
Form1099TypestringDenotes the type of 1099 form.
Form1099RecordsobjectPulls Form 1099-PATR records with Success and Error statuses
    SuccessRecordsobject[]It will show detailed information about the success status of Form 1099-PATR Records
        SequenceIdstringA 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.
        RecordIdGuidA Unique identifier generated by TaxBandits when a 1099-PATR return is created.
        RecipientIdGuidA 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.
        FederalReturnobjectReturns the record status and StatusTs of federal return.
            StatusstringReturns the record status.
            StatusTsstringReturns date and time of return created.
            InfostringReturns information about the Federal Filing service.
        PostalobjectReturns the status and StatusTs of postal mailing service for Form 1099-PATR.
            StatusstringReturns the status of postal order.
            StatusTsstringReturns the date and time of the postal order created.
            InfostringReturns the information about Postal mailing service.
        OnlineAccessobjectReturns the Email address for whom the online access to be given and Status of online access.
            StatusstringReturns status of online access for Form 1099-PATR return.
            EmailstringEmail address for whom the online access to be given.
            InfostringInformation about the online access service.
        ScheduleFilingobjectReturns the date of the schedule filing.
            ScheduledOnstringDate of the schedule filing to know when the return to be filed to the IRS.
            InfostringInformation about Schedule Filing service.
    ErrorRecordsobject[]It will show the detailed information about the error status of Form 1099-PATR Records.
        SequenceIdstringA 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.
        RecordIdGuidUnique identifier of a record
        Errorsobject[]Shows detailed error information
            IdstringReturns the validation error Id
            NamestringName of the validation error
            MessagestringDescription of the validation error
Errorsobject[]Shows detailed error information
    IdstringReturns the validation error Id
    NamestringName of the validation error
    MessagestringDescription 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": "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",
                "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",
                "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",
                "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",
                "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",
                "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
}