List
Lists all Form 1099-PATR returns in TaxBandits that have been created and transmitted for a particular SubmissionId or BusinessId. Based on the filters supplied in the request, the results will be listed. If you provide a BusinessId, for example, all returns created under that BusinessId will be listed.
GET Form1099PATR/List
Request Body
Field | Type | Description |
---|---|---|
SubmissionId | Guid | Unique identifier of a submission |
BusinessId | Guid | Unique identifier of a business |
TINType | string | List the 1099 PATR records based on the given TINType and TIN. |
TIN | string | List the 1099 PATR records based on the given TIN. |
TaxYear | string | List the 1099 PATR records based on the given taxyear. |
Page | number | Pulls the records listed in the page selected |
PageSize | number | Number of 1099 PATR records to be listed in each page. |
EfileStatus | string | List the 1099 PATR records based on the status ("CREATED, UNDERPROCESS, SENTTOAGENCY, TRANSMITTED, ACCEPTED, REJECTED") |
FromDate | string | Enter a date from which the Form 1099-PATR records need to be listed. |
ToDate | string | Enter a date till which the 1099-PATR records created are to be listed. |
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 |
Form1099Type | string | Denotes the type of 1099 form. |
Form1099Records | object[] | Returns detailed information of the Form 1099 R records. |
SubmissionId | Guid | Unique identifier of a submission |
BusinessId | Guid | Unique identifier of a business |
PayerRef | string | Unique identifier of the payer. |
BusinessNm | string | Name of the business |
IsEIN | Boolean | When true, identifies the business with an EIN. |
EINorSSN | string | When IsEIN is true, use Employer Identification Number (EIN). When IsEIN is false, use Social Security Number (SSN) |
ContactNm | string | Contact Name of the Business. |
TaxYear | string | Tax year of 1099 PATR to be filed. |
Recipient | object | Details of the Recipient. |
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. |
RecipientNm | Boolean | Name of Recipient. |
TINType | string | TIN type of the Recipient. |
TIN | string | TIN of the Recipient. |
Status | string | The status of Form 1099 PATR. |
TotalRecords | number | Total number of records. |
TotalPages | number | Total number of pages. |
Page | number | Pulls the records listed in the page selected |
PageSize | number | Number of 1099 PATR records to be listed in each page. |
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 JSON
"Form1099PATR/List?SubmissionId=48f07d71-9afb-4150-aea7-6822a3374cfc&BusinessId=cfa1f87c-046d-47a6-b69d-3b17ec006c27&TINType=SSN&TIN=043313330&TaxYear=2021&Page=1&PageSize=10&EfileStatus=ALL&FromDate=11-01-2021&ToDate=11-30-2021"
Response JSON
{
"StatusCode": 200,
"StatusName": "Ok",
"StatusMessage": "Successful API call",
"Form1099Type": "PATR",
"Form1099Records": [
{
"SubmissionId": "48f07d71-9afb-4150-aea7-6822a3374cfc",
"BusinessId": "cfa1f87c-046d-47a6-b69d-3b17ec006c27",
"PayerRef": "AB101",
"BusinessNm": "Eastman Kodak Com",
"IsEIN": false,
"EINorSSN": "043313330",
"ContactNm": "John",
"TaxYear": "2021",
"Recipient": {
"SequenceId": "1",
"RecordId": "aa98cb08-adfb-4557-af41-17dbf314f47f",
"RecipientId": "ba7e67f0-400c-4a90-9f56-4039beaa68d2",
"RecipientNm": "Mark Davis",
"TINType": "EIN",
"TIN": "39-3817572",
"Status": "CREATED"
}
}
],
"Page": 1,
"TotalRecords": 1,
"TotalPages": 1,
"PageSize": 100,
"Errors": null
}