Skip to main content
Version: 1.7.1

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 
Run in Postman

Request Params

FieldTypeDescription
SubmissionIdGuidUnique identifier of a submission
BusinessIdGuidUnique identifier of a business
TINTypestringList the 1099-PATR records based on the given TINType and TIN.
TINstringList the 1099-PATR records based on the given TIN.
TaxYearstringList the 1099-PATR records based on the given taxyear.
Allowed values: "2022","2023"
PagenumberPulls the records listed in the page selected
PageSizenumberNumber of 1099-PATR records to be listed in each page.
EfileStatusstringList the 1099-PATR records based on the status ("CREATED, UNDERPROCESS, SENTTOAGENCY, TRANSMITTED, ACCEPTED, REJECTED")
FromDatestringEnter a date from which the Form 1099-PATR records need to be listed in MM/DD/YYYY format.
ToDatestringEnter a date till which the 1099-PATR records created are to be listed in MM/DD/YYYY format.

Request Params

"Form1099PATR/list?SubmissionId=e4ab74cf-19c0-4a03-80b9-ad2ca8f90023&BusinessId=1b11b146-f386-424d-b3a5-b2fe7d247bf4&TIN=256196477&Page=1&PageSize=10&EfileStatus=ALL&FromDate=11-01-2022&ToDate=11-30-2022&TINType=SSN"

Response Body

FieldTypeDescription
StatusCodenumberReturns the HTTP status codes like 200,300 etc.
StatusNamestringName of the status code
StatusMessagestringDetailed status message
Form1099TypestringDenotes the type of 1099 form.
Form1099Recordsobject[]Returns detailed information of the Form 1099 R records.
    SubmissionIdGuidUnique identifier of a submission
    BusinessIdGuidUnique identifier of a business
    PayerRefstringUnique identifier of the payer.
    BusinessNmstringName of the business
    FirstNmstringFirst Name of the Individual
    MiddleNmstringMiddle Name of the Individual
    LastNmstringLast Name of the Individual
    SuffixstringSuffix of the Individual
    IsEINBooleanWhen true, identifies the business with an EIN.
    EINorSSNstringWhen IsEIN is true, use Employer Identification Number (EIN). When IsEIN is false, use Social Security Number (SSN)
    ContactNmstringContact Name of the Business.
    TaxYearstringTax year of 1099-PATR to be filed.
    RecipientobjectDetails of the Recipient.
        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.
        RecipientNmstringName of Recipient.
        FirstNmstringFirst Name of the Individual
        MiddleNmstringMiddle Name of the Individual
        LastNmstringLast Name of the Individual
        SuffixstringSuffix of the Individual
        TINTypestringTIN type of the Recipient.
        TINstringTIN of the Recipient.
        StatusstringThe status of Form 1099-PATR.
TotalRecordsnumberTotal number of records.
TotalPagesnumberTotal number of pages.
PagenumberPulls the records listed in the page selected
PageSizenumberNumber of 1099-PATR records to be listed in each page.
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",
"Form1099Type": "PATR",
"Form1099Records": [
{
"SubmissionId": "e4ab74cf-19c0-4a03-80b9-ad2ca8f90023",
"BusinessId": "2c12d45c-9d34-4cfd-acab-ada8613250a1",
"PayerRef": "Snow123",
"BusinessNm": "Snowdaze LLC",
"FirstNm": null,
"LastNm": null,
"MiddleNm": null,
"Suffix": null,
"IsEIN": true,
"EINorSSN": "71-3787159",
"ContactNm": null,
"TaxYear": "2023",
"Recipient": {
"SequenceId": "2",
"RecordId": "c440f432-faad-494c-8af5-746781700783",
"RecipientId": "359733eb-9776-43f5-9938-7573c16083ff",
"RecipientNm": null,
"FirstNm": "Mark",
"LastNm": "Davis",
"MiddleNm": null,
"Suffix": null,
"TINType": "SSN",
"TIN": "36-3814237",
"FederalReturn": {
"Status": "CREATED",
"StatusTs": "2024-06-28 23:46:40 -04:00",
"Info": null,
"Errors": null
},
"Postal": null,
"OnlineAccess": {
"Status": "CREATED",
"Email": "chandler@sample.com",
"Info": null
}
}
}
],
"Page": 1,
"TotalRecords": 1,
"TotalPages": 1,
"PageSize": 100,
"Errors": null
}