Skip to main content
Version: 1.7.0

GetPDF

This method will generate the completed Form 941 in a Pdf format using the SubmissionId and RecordID.  After a successful API call, a Webhook will be sent with a link to download the PDFs.

PDF URL will now be available in PDF Complete Webhook.

GET Form941/GetPDF 
Run in Postman

Request Params

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

Request Params

"Form941/GetPDF?SubmissionId=8847cee7-2275-4493-a5c3-c06ed1de530c&RecordIds=f93602df-ceaf-48a4-a3cf-431bb6b6ddba"

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
Form941pdfRecordsobject[]Form941pdfRecords Object
    RecordIdGuidUnique identifier of a record
    SequenceIdstringAn 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
    Form941pdfstringReturns the record ID with success message after generating a PDF.
Errorsobject[]Shows detailed error information.
    IdstringReturns the validation error id.
    NamestringName of the validation error.
    MessagestringDescription 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": "f2fee2f8-74bf-4e1d-9239-399e76929475",
"Form941pdfRecords": [
{
"RecordId": "ed6bc24b-189d-419b-9224-2dd2bf3b7467",
"SequenceId": "001",
"Form941pdf": "We've successfully received your request to generate PDF. You will be notified with the URL to download the PDF."
}
],
"Errors": null
}