List
GET Form1099Q/List
Request Params
Field | Type | Description |
---|---|---|
SubmissionId | Guid | Unique identifier of a submission |
BusinessId | Guid | Unique identifier of a business |
TINType | string | List the 1099-Q records based on the given TINType and TIN. |
TIN | string | List the 1099-Q records based on the given TIN. |
TaxYear | string | List the 1099-Q records based on the given taxyear. Allowed values: "2022","2023" |
Page | number | Pulls the records listed in the page selected |
PageSize | number | Number of 1099-Q records to be listed in each page. |
EfileStatus | string | List the 1099-Q records based on the status ("CREATED, UNDERPROCESS, SENTTOAGENCY, TRANSMITTED, ACCEPTED, REJECTED") |
FromDate | string | Enter a date from which the Form 1099-Q records need to be listed in MM/DD/YYYY format. |
ToDate | string | Enter a date till which the 1099-Q records created are to be listed in MM/DD/YYYY format. |
Request Params
"Form1099Q/List?SubmissionId=d585499a-750c-4087-a9a1-cf996a0ed5a7&BusinessId=dc99dc59-5c71-4660-9a97-ec23fe50be6a&TINType=SSN&TIN=197-79-6556&TaxYear=2023&Page=1&PageSize=10&EfileStatus=ALL&FromDate=05-05-2023&ToDate=05-20-2023"
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-Q 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 |
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 |
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-Q 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-Q return is created. |
RecipientId | Guid | A unique identifier generated by TaxBandits for a Recipient when a 1099-Q return is created. You can use this id for your future reference to Update. |
RecipientNm | Boolean | Name of Recipient. |
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 |
TINType | string | TIN type of the Recipient. |
TIN | string | TIN of the Recipient. |
Status | string | The status of Form 1099-Q. |
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-Q 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 |
Response JSON
Success Response - This is a sample response for successful API requests.
{
"StatusCode": 200,
"StatusName": "Ok",
"StatusMessage": "Successful API call",
"Form1099Type": "Q",
"Form1099Records": [
{
"SubmissionId": "d585499a-750c-4087-a9a1-cf996a0ed5a7",
"BusinessId": "dc99dc59-5c71-4660-9a97-ec23fe50be6a",
"PayerRef": "hXZ65gba",
"BusinessNm": "Snowdaze LLC",
"IsEIN": true,
"EINorSSN": "34-5649084",
"ContactNm": "Hannah Gusikowski Jr.",
"TaxYear": "2023",
"Recipient": {
"SequenceId": "1",
"RecordId": "8518a94d-76f4-412b-b958-c0aa41cfce20",
"RecipientId": "841fa380-40b9-4b53-8e8e-c9739e13ac4c",
"RecipientNm": "Alena Rice",
"TINType": "SSN",
"TIN": "197-79-6556",
"FederalReturn": {
"Status": "CREATED",
"StatusTs": "2023-05-16 09:21:21 +00:00",
"Info": null,
"Errors": null
},
"Postal": {
"Status": "CREATED",
"StatusTs": "2023-05-16 09:21:21 +00:00",
"Info": null
},
"OnlineAccess": null
}
}
],
"TotalRecords": 1,
"TotalPages": 1,
"Page": 1,
"PageSize": 10,
"Errors": null
}