GetPDF
This method will generate the completed 1099-NEC in a PDF format using the SubmissionId and RecordId. If your request contains only the SubmissionId, you’ll receive the PDF of all the records under that submission. If you provide the RecordIds along with the SubmissionId, you’ll get the PDFs of only those records.
After a successful API call, a Webhook will be sent with a link to download the PDFs. You’ll receive a separate ZIP file for each record. The ZIP file will contain the form copies of the corresponding recipient.
The files are not encrypted, and you can directly download them. For security purposes, the file link will expire after 24 hours from the time of PDF Webhook delivery.
Also, there is an option available to choose the TIN masking types. The Recipient's TIN will be masked or unmasked based on the client's preference.
GET Form1099NEC/GetPDF
Request Params
Field | Type | Description |
---|---|---|
SubmissionId | Guid | Unique identifier of a submission |
RecordIds | Guid[] | Optional Unique identifier of a records. |
TINMaskType | string | Optional Choose the masking type of your Recipient's TIN on the 1099-NEC PDF. MASKED - The Recipient's TIN will be masked in the PDF. Only last 4 digits of the TIN can be read. UNMASKED - The Recipient's TIN will not be masked in the PDF. To protect the PII information of the Recipient, the PDF with Unmasked TIN is password protected. Use the Recipient's TIN (password) to open the protected file. BOTH - Two PDF's will be delivered for each Recipient. One with Masked TIN and the other with Unmasked TIN. The PDF with Unmasked TIN will be password protected.Allowed values"MASKED", "UNMASKED", "BOTH" |
Request Params
Request Pdf for the given BusinessID and RecordID of the recipient. Here, TINMaskType is given as Unmasked. So, the Pdf is password protected.
"Form1099NEC/GetPdf?SubmissionId=9d71ae45-df5f-49f7-86f8-e88f54132fa1&RecordIds=01132f6d-ef4a-4014-817e-94a5a19bd52b,eb39714e-f653-4c4d-a53c-07f24f9a9dj5&TINMaskType=UNMASKED"
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 |
Form1099NecRecords | object[] | Collection of Form 1099-NEC records for which the PDF will be successfully delivered |
RecordId | Guid | Unique identifier of a record |
Message | string | Provides additional information regarding the PDF delivery. |
Errors | object[] | Shows detailed error information |
Id | string | Returns the validation error code |
Name | string | Name of the validation error |
Message | string | Description of the validation error |
Response JSON
Pdf will be generated in the Webhook for the completed 1099-NEC for the given BusinessId and RecordIDs.
{
"StatusCode": 200,
"StatusName": "Ok",
"StatusMessage": "Successful API call",
"SubmissionId": "9d71ae45-df5f-49f7-86f8-e88f54132fa1",
"Form1099NecRecords": [
{
"RecordId": "01132f6d-ef4a-4014-817e-94a5a19bd52b",
"Message": "We've successfully received your request to generate PDF. You will be notified with the URL to download the PDF."
},
{
"RecordId": "eb39714e-f653-4c4d-a53c-07f24f9a9dj5",
"Message": "We've successfully received your request to generate PDF. You will be notified with the URL to download the PDF."
}
],
"Errors": null
}