Skip to main content
Version: 1.7.1

GetPDF

Request a PDF download of forms 941SCHR, 941 and 8974 to be made available through Webhooks.

GET Form941SCHR/GetPDF 
Run in Postman

Request Params

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

Request Params

"Form941SCHR/GetPDF?SubmissionId=8e73ad5f-47c9-46b8-ae35-9f4c7432ffa9&RecordIds=d3888fc3-fee0-4020-bd6d-2a3795beff37"

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[]Object that returns record ID and status message on the availability of PDF via webhooks.
    RecordIdGuidUnique identifier of a record.
    Form941pdfstringReturns the status message on the availability of PDF via webhooks.
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": "8e73ad5f-47c9-46b8-ae35-9f4c7432ffa9",
"Form941pdfRecords": [
{
"RecordId": "d3888fc3-fee0-4020-bd6d-2a3795beff37",
"Form941pdf": "We've successfully received your request to generate PDF. You will be notified with the URL to download the PDF."
}
],
"Errors": null
}