GetPDF

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

GET Form940/GetPDF 

Request Params

Field	Type	Description
SubmissionId	string	Unique identifier of a submission
RecordIds	string	List of record Ids to be downloaded.

Request Params

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

Response Body

Field	Type	Description
StatusCode	number	Returns the HTTP status codes like 200,300 etc.
StatusName	string	Name of the status code.
StatusMessage	string	Detailed status message.
SubmissionId	Guid	Unique identifier of a submission
Form940pdfRecords	object[]	Form940pdfRecords Object
RecordId	Guid	Unique identifier of a record
Form940pdf	string	Returns the record ID with success message after generating a PDF.
Errors	object[]	Shows detailed error information.
Code	string	Returns the validation error code.
Name	string	Name of the validation error.
Message	string	Description of the validation error.
Type	string	Type 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
}