GetPDF
Request a PDF download of forms 941SCHR, 941 and 8974 to be made available through Webhooks.
GET Form941SCHR/GetPDF
Request Params
Field | Type | Description |
---|---|---|
SubmissionId | string | Unique identifier of a submission. |
RecordIds | string | List of record Ids to be downloaded. |
Request Params
"Form941SCHR/GetPDF?SubmissionId=8e73ad5f-47c9-46b8-ae35-9f4c7432ffa9&RecordIds=d3888fc3-fee0-4020-bd6d-2a3795beff37"
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. |
Form941pdfRecords | object[] | Object that returns record ID and status message on the availability of PDF via webhooks. |
RecordId | Guid | Unique identifier of a record. |
Form941pdf | string | Returns the status message on the availability of PDF via webhooks. |
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": "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
}