List
Lists all Form 1099-R returns created and transmitted on the account for a particular Submission or Payer. Form 1099-R returns will be listed based on the filters sent in the Request.
GET Form1099R/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 R records based on the given TINType and TIN. |
TIN | string | List the 1099 R records based on the given TIN. |
TaxYear | string | List the 1099 R records based on the given taxyear. |
Page | number | Pulls the records listed in the page selected |
PageSize | number | Number of 1099 R records to be listed in each page. |
EfileStatus | string | List the 1099 R records based on the status ("CREATED, UNDERPROCESS, SENTTOAGENCY, TRANSMITTED, ACCEPTED, REJECTED") |
FromDate | string | Enter a date from which the Form 1099-R records need to be listed. |
ToDate | string | Enter a date till which the 1099-R 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 R 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-R return is created. |
    RecipientId | Guid | A unique identifier generated by TaxBandits for a Recipient when a 1099-R 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 R. |
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 R 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
Form1099R/List?SubmissionId=524af29a-a859-46a0-9223-110e02ec4660&BusinessId=cfa1f87c-046d-47a6-b69d-3b17ec006c27&TINType=SSN&TIN=043313330&TaxYear=2022&Page=1&PageSize=10&EfileStatus=ALL&FromDate=11-01-2022&ToDate=11-30-2022
Response JSON
{ "StatusCode": 200, "StatusName": "Ok", "StatusMessage": "Successful API call", "Form1099Type": "R", "Form1099Records": [ { "SubmissionId": "524af29a-a859-46a0-9223-110e02ec4660", "BusinessId": "cfa1f87c-046d-47a6-b69d-3b17ec006c27", "PayerRef": "4965", "BusinessNm": "Brian LLC", "IsEIN": false, "EINorSSN": "043-31-3330", "ContactNm": "Brian O Relly", "TaxYear": "2022", "Recipient": { "SequenceId": "001", "RecordId": "55f703fc-4456-4ca6-ab5a-004cf714a95f", "RecipientId": "e5a1380a-ba82-4068-8180-60698227b33d", "RecipientNm": "Mark Davis", "TINType": "SSN", "TIN": "391-11-4511", "Status": "TRANSMITTED" } } ], "TotalRecords": 1, "TotalPages": 1, "Page": 1, "PageSize": 100, "Errors": null}