List
GET Form1099SA/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 SA records based on the given TINType and TIN. |
TIN | string | List the 1099 SA records based on the given TIN. |
TaxYear | string | List the 1099 SA records based on the given taxyear. Allowed values:"2023","2024" |
Page | number | Pulls the records listed in the page selected. |
PageSize | number | Number of 1099 SA records to be listed in each page. |
EfileStatus | string | List the 1099 SA records based on the status ("CREATED, UNDERPROCESS, SENTTOAGENCY, TRANSMITTED, ACCEPTED, REJECTED") |
FromDate | string | Enter a date from which the Form 1099SA records need to be listed in MM/DD/YYYY format. |
ToDate | string | Enter a date till which the 1099SA records created are to be listed in MM/DD/YYYY format. |
Request Params
form1099SA/List?SubmissionId=1875b2f6-5b09-45f5-a906-d2bfde5d8625&TINType=SSN&TIN=092167881&Page=1&FromDate=01/02/2024&ToDate=01/10/2024&EfileStatus=CREATED&BusinessId=f6d35e63-0ebe-450b-9485-cdcd72487aff&TaxYear=2024
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 |
Form1099SAType | string | Denotes the type of 1099 SA form. |
Form1099SARecords | object[] | Returns detailed information of the Form 1099 SA 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 SA 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 SA return is created. |
RecipientId | Guid | A unique identifier generated by TaxBandits for a Recipient when a 1099 SA 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. |
FederalReturn | object | Returns the record status and StatusTs of federal return service for Form 1099 SA. |
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 detailed error information. |
Postal | object | Returns the status and StatusTs of postal mailing service for Form 1099 SA. |
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 SA return. |
string | Email address for whom the online access to be given. | |
Info | string | Information about the online access service. |
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 1099SArecords 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": "SA",
"Form1099Records": [
{
"SubmissionId": "1875b2f6-5b09-45f5-a906-d2bfde5d8625",
"BusinessId": "2c12d45c-9d34-4cfd-acab-ada8613250a1",
"PayerRef": "Snow123",
"BusinessNm": "Snowdaze LLC",
"FirstNm": null,
"MiddleNm": null,
"LastNm": null,
"Suffix": null,
"IsEIN": true,
"EINorSSN": "71-3787159",
"ContactNm": null,
"TaxYear": "2024",
"Recipient": {
"SequenceId": "1",
"RecordId": "6f7ce510-74f6-4732-b3da-996e18976dff",
"RecipientId": "d85fbc97-2eb8-4ffc-ba47-b70a3261a261",
"RecipientNm": "Dairy Delights LLC Coco Milk",
"FirstNm": null,
"MiddleNm": null,
"LastNm": null,
"Suffix": null,
"TINType": "EIN",
"TIN": "36-3814577",
"FederalReturn": {
"Status": "CREATED",
"StatusTs": "2024-06-29 00:12:12 -04:00",
"Info": null,
"Errors": null
},
"Postal": null,
"OnlineAccess": {
"Status": "CREATED",
"Email": "shawn@sample.com",
"Info": null
}
}
}
],
"TotalRecords": 1,
"TotalPages": 1,
"Page": 1,
"PageSize": 100,
"Errors": null
}