GetPDF

Use this method to retrieve the PDF of the completed Form 941-X by providing the SubmissionId and RecordID. After a successful API call, a Webhook will be sent with a link to download the PDFs.

note

You must configure Webhook for the event type 'PDF Complete'.

GET Form941X/GetPDF 

Request Params

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

Request Params

"Form941X/GetPDF?SubmissionId=7c1f1df2-61f1-4881-88d5-2a5db230e987&RecordIds=9ae8badc-d68e-4913-a050-fae80d0a9acd"

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
Form941XpdfRecords	object[]	Form941XpdfRecords Object
RecordId	Guid	Unique identifier of a record
SequenceId	string	An unique reference ID for the submission that can be used to identify a particular record. The Sequence ID will be returned in the Response for your reference. Size Range: 50
Form941Xpdf	string	Returns the record ID with success message after generating a PDF.
Errors	object[]	Shows detailed error information.
Id	string	Returns the validation error id.
Name	string	Name of the validation error.
Message	string	Description of the 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",
 "Form941XpdfRecords": [
   {
     "RecordId": "22af7b4b-42f2-4e68-a9ac-743d2fd76636",
     "Form941Xpdf": "We've successfully received your request to generate PDF. You will be notified with the URL to download the PDF."
   }
 ],
 "Errors": null
}