Skip to main content
Version: 1.7.0

GetPDF

Request a PDF download of 940 to be made available through Webhooks

GET Form940/GetPDF 
Run in Postman

Request Params

FieldTypeDescription
SubmissionIdstringUnique identifier of a submission
RecordIdsstringList of record Ids to be downloaded.

Request Params

"Form940/GetPDF?SubmissionId=7f9cb1ab-f90b-4358-ae5f-acfe19617d96&RecordIds=22af7b4b-42f2-4e68-a9ac-743d2fd76636"

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": "7f9cb1ab-f90b-4358-ae5f-acfe19617d96",
"Form940pdfRecords": [
{
"RecordId": "22af7b4b-42f2-4e68-a9ac-743d2fd76636",
"Form940pdf": "We've successfully received your request to generate PDF. You will be notified with the URL to download the PDF."
}
],
"Errors": null
}