GetRecordDetailBySubmissionId
Gets information of the Records using the Submission Id.
GET Utility/GetRecordDetailBySubmissionId
Request Params
Field | Type | Description |
---|---|---|
SubmissionId | guid | Unique identifier of a submission |
Page | number | Pulls the records listed in the page selected |
PageSize | number | Number of 1099 records to be listed in each page. Note: PageSize can be maximum of 100. |
Request Params
"Utility/GetRecordDetailBySubmissionId?SubmissionId=db283d52-9c19-4923-90f7-02479204b9a6&Page=1&PageSize=100"
Response Body
Field | Type | Description |
---|---|---|
StatusCode | number | Returns the HTTP status codes like 200,400 etc. |
StatusName | string | Name of the status code. |
StatusMessage | string | Detailed status message. |
BusinessId | guid | Returns the unique identifier of the business. |
RecordDetails | object[] | Object to identify the record details. |
RecordId | guid | Unique identifier of a record |
RecipientId | guid | A unique identifier generated by TaxBandits for a Recipient. |
TINType | string | Returns the TIN type of the recipient |
TIN | string | Returns the TIN of the recipient |
PayeeRef | string | A unique identifier for each payee completing their information |
FormType | string | Returns the form type of the given SubmissionId |
AccountNum | string | Returns the account number of the recipient |
TotalRecords | number | Total number of records listed in the response. |
TotalPages | number | Total number of pages |
Page | number | Returns the page number in which the records are listed |
PageSize | number | Number of records 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",
"BusinessId": "01199a10-5717-44c0-bf0e-65e6faefc13b",
"RecordDetails": [
{
"RecordId": "f1ad42a3-4af2-42bc-a688-e843a1ef3ccb",
"RecipientId": "e50e7aa1-b202-4b80-960b-b47189a299ff",
"TINType": "SSN",
"TIN": "745-21-6396",
"PayeeRef": null,
"FormType": "Form1099MISC",
"AccountNum": "32505369"
}
],
"TotalRecords": 1,
"TotalPages": 1,
"Page": 1,
"PageSize": 100,
"Errors": null
}