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
Request Params
Field | Type | Description |
---|---|---|
SubmissionId | string | Unique identifier of a submission |
RecordIds | string | List of record Ids to be downloaded. |
Request Params
"Form941/GetPDF?SubmissionId=8847cee7-2275-4493-a5c3-c06ed1de530c&RecordIds=f93602df-ceaf-48a4-a3cf-431bb6b6ddba"
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[] | Form941pdfRecords 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 |
Form941pdf | 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": "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
}