Skip to main content
Version: 1.7.3

GetRecordDetailBySubmissionId

Gets information of the Records using the Submission Id.

GET Utility/GetRecordDetailBySubmissionId 
Run in Postman

Request Params

FieldTypeDescription
SubmissionIdguidUnique identifier of a submission
PagenumberPulls the records listed in the page selected
PageSizenumberNumber 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

FieldTypeDescription
StatusCodenumberReturns the HTTP status codes like 200,400 etc.
StatusNamestringName of the status code.
StatusMessagestringDetailed status message.
BusinessIdguidReturns the unique identifier of the business.
RecordDetailsobject[]Object to identify the record details.
RecordIdguidUnique identifier of a record
RecipientIdguidA unique identifier generated by TaxBandits for a Recipient.
TINTypestringReturns the TIN type of the recipient
TINstringReturns the TIN of the recipient
PayeeRefstringA unique identifier for each payee completing their information
FormTypestringReturns the form type of the given SubmissionId
AccountNumstringReturns the account number of the recipient
TotalRecordsnumberTotal number of records listed in the response.
TotalPagesnumberTotal number of pages
PagenumberReturns the page number in which the records are listed
PageSizenumberNumber of records 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",
"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
}