List
Lists all Form 1099-PATR correction returns created and transmitted on the account for a particular Submission or Payer. Form 1099-PATR correction returns will be listed based on the filters sent in the Request.
GET Form1099PATRCorrection/List
Request Params
Field | Type | Description |
---|---|---|
SubmissionId | Guid | This is a Unique Identifier of a Submission. Use this node, if you want to list the 1099-PATR correction records created under a Submission. Ignore this node, if you want to list the records of a particular Payer. |
BusinessId | Guid | This is a Unique Identifier of a Payer. Use this node, if you want to list all the 1099-PATR correction records created under the Payer. Ignore this node, if you want to list the records for a Submission. |
TINType | string | Mention TIN type and TIN, if you do not have Business ID and want to list all the 1099-PATR correction records created under a Payer. Allowed Values: EIN, SSN |
TIN | string | Employer Identification Number or Social Security Number of the Payer is required only when you have not provided the SubmissionId or the BusinessId |
TaxYear | string | Enter the specific tax year for the list of 1099-PATR correction Records. If the tax year is not given, all tax year records will be listed. |
Page | number | Mention the page number that needs to be listed in the Response. If the value is not given, the page will be defaulted to 1. |
PageSize | number | Provide a numerical value to list the total number of Form 1099-PATR correction records in each page. If the value is not given, then the page size will be defaulted to 100. |
EfileStatus | string | Mention Form 1099-PATR correction record status that needs to be listed. If the value is not given, then records with all the statuses will be listed. |
FromDate | string | Enter a date from which the Form 1099-PATR correction records need to be listed in MM/DD/YYYY format. |
ToDate | string | Enter a date till which the 1099-PATR correction records created are to be listed in MM/DD/YYYY format. |
Request Params
Form1099PATRCorrection/List?BusinessId=97d34410-87b1-4921-9ae6-3e0311e78103&TaxYear=2024&Page=1&PageSize=10&EfileStatus=ALL&FromDate=11-01-2024&ToDate=11-30-2024
Response Body
Field | Type | Description |
---|---|---|
StatusCode | number | Returns the HTTP status codes like 200,300 etc. |
StatusName | string | Submission Status |
StatusMessage | string | Status Details |
Form1099Type | string | Denotes the type of 1099 form. |
Form1099Records | object[] | It contains the list of 1099 records. |
SubmissionId | Guid | Unique Identifier of a Submission |
BusinessId | Guid | Unique Identifier of a Payer |
BusinessNm | string | Payer's Name |
FirstNm | string | First Name of the Individual |
MiddleNm | string | Middle Name of the Individual |
LastNm | string | Last Name of the Individual |
0Suffix | string | Suffix of the Individual |
ContactNm | string | Contact Name of the Payer. |
TaxYear | string | Tax year of the 1099-PATR correction records. |
Recipient | object | Recipient Details |
SequenceId | string | Sequence ID of the 1099-PATR correction record provided during CREATE or UPDATE |
RecordId | Guid | Unique identifier of the 1099-PATR correction record. |
RecipientId | Guid | Unique identifier of the Recipient. |
RecipientNm | Boolean | Recipient's Name |
FirstNm | string | First Name of the Individual |
MiddleNm | string | Middle Name of the Individual |
LastNm | string | Last Name of the Individual |
Suffix | string | Suffix of the Individual |
TIN | string | Recipient's TIN |
Status | string | Record Status of Form 1099-PATR correction. |
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. |
Errors | object[] | Shows error information of state returns of Form 1099 PATR correction |
Postal | object | Returns the status and StatusTs of postal mailing service for Form 1099 PATR correction. |
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 correction return. |
string | Email address for whom the online access to be given. | |
Info | string | Information about the online access service. |
TotalRecords | number | Total records. |
TotalPages | number | Total pages. |
Page | number | List of records mentioned in the Request |
PageSize | number | Total 1099-PATR correction records in the page |
Errors | object[] | Show Error Details |
Id | string | Returns the validation error id |
Name | string | Name of the validation error |
Message | string | Validation error details |
Response JSON
Success Response - This is a sample response for successful API requests.
{
"StatusCode": 200,
"StatusName": "Ok",
"StatusMessage": "Successful API call",
"Form1099Type": "PATRCORRECTION",
"Form1099Records": [
{
"SubmissionId": "573087a5-ac58-49fc-a17c-93dab9f7aa69",
"BusinessId": "97d34410-87b1-4921-9ae6-3e0311e78103",
"PayerRef": "RN1241045",
"BusinessNm": "Snowdaze LLC",
"IsEIN": true,
"FirstNm": null,
"LastNm": null,
"MiddleNm": null,
"Suffix": null,
"EINorSSN": "62-2269252",
"ContactNm": "Chandler White",
"TaxYear": "2024",
"Recipient": {
"SequenceId": "001",
"RecordId": "2d04415e-2365-43c2-bbfb-3c801c7ebd7b",
"RecipientId": "7f81b560-2f91-4aeb-9365-1fa233a95946",
"RecipientNm": null,
"FirstNm": "Willis",
"LastNm": "Carrier",
"MiddleNm": "H",
"Suffix": null,
"TINType": "SSN",
"TIN": "563-81-2364",
"Status": "CREATED",
"FederalReturn": {
"Status": "CREATED",
"StatusTs": "2025-02-27 01:45:39 -05:00",
"Info": null,
"Errors": null
},
"Postal": {
"Status": "CREATED",
"StatusTs": "2025-02-27 01:45:39 -05:00",
"Info": null
},
"OnlineAccess": {
"Status": "NA",
"Email": null,
"Info": "This Service will be available soon"
}
}
}
],
"Page": 1,
"TotalRecords": 1,
"TotalPages": 1,
"PageSize": 100,
"Errors": null
}