Skip to main content
Version: 1.7.3

GetPDF

GetPDF

Request a PDF download of 945 to be made available through Webhooks.

GET Form945/GetPDF 

Request Params

FieldTypeDescription
SubmissionIdstringUnique identifier of a submission
RecordIdsstringOptional 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
Form945pdfRecordsobject[]Form945pdfRecords Object
    RecordIdGuidUnique identifier of a record
    Form945pdfstringReturns the record ID with success message after generating a PDF.
Errorsobject[]Shows detailed error information.
    IdstringReturns the validation error code.
    NamestringName of the validation error.
    MessagestringDescription of the validation error.

Request Params

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