Skip to main content
Version: 1.7.1

GetPDF

Request a PDF download of forms 940SCHR and 940 to be made available through Webhooks.

GET Form940SchR/GetPDF 
Run in Postman

Request Params

FieldTypeDescription
SubmissionIdstringUnique identifier of a submission
RecordIdsstringDownloads a list of Record IDs

Request Params

"Form940SCHR/GetPDF?SubmissionId=9723f666-c46e-43e6-8c56-8cba391acbf7&RecordIds=554fb9c3-b68b-4a52-9114-792cd4a70433"

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
Form940pdfRecordsobject[]Form940pdfRecords Object
    RecordIdGuidUnique identifier of a record
    Form940pdfstringReturns the record ID with success message after generating a 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.

Response JSON

Success Response - This is a sample response for successful API requests.

{
"StatusCode": 200,
"StatusName": "Ok",
"StatusMessage": "Successful API call",
"SubmissionId": "9723f666-c46e-43e6-8c56-8cba391acbf7",
"Form940pdfRecords": [
{
"RecordId": "554fb9c3-b68b-4a52-9114-792cd4a70433",
"Form940pdf": "We've successfully received your request to generate PDF. You will be notified with the URL to download the PDF."
}
],
"Errors": null
}