Extend your software with TaxBandits IRS E-file API Integration

Skip to main content
Version: 1.7.1

GetPDF

Request a PDF download of New Hire report to be made available through Webhooks

GET NewHireReport/GetPDF

Request Body

FieldTypeDescription
SubmissionIdGuidUnique identifier of a submission
RecordIdsGuid[]List of record Ids to be downloaded.

Response Body

FieldTypeDescription
StatusCodenumberReturns the HTTP status codes like 200,300 etc.
StatusNamestringName of the status code.
StatusMessagestringDetailed status message.
SubmissionIdGuidUnique identifier of a submission.
NHReportPdfbyte[]Byte array of New Hire report pdf
Errorsobject[]Shows detailed error information.
    CodestringReturns the validation error code.
    NamestringName of the validation error.
    MessagestringDescription of the validation error.
    TypestringType of validation error.

Request JSON

{
"SubmissionId": "31eb9b80-a935-4204-b32c-14db8d99a57e",
"RecordIds": [
"2ffde35c-c885-45c6-ab48-424a89c838ed"

]
}

Response JSON

{
"StatusCode": 200,
"StatusName": "Ok",
"StatusMessage": "Successful API call",
"SubmissionId": "f1ed3955-1b64-408c-a730-9008a192db3f",
"NHReportPdf": "QEA=",
"Errors": null
}