GetPDF
Retrieves Form 1099-MISC PDFs. The link for PDFs download will be sent via Webhook after successful API call.
GET Form1099MISC/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-MISC 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
"Form1099MISC/GetPDF?SubmissionId=efacde0b-93e4-4327-84f5-f003b14fdc47&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 |
Form1099MiscRecords | object[] | Collection of Form 1099-MISC 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 |
Code | string | Returns the validation error code |
Name | string | Name of the validation error |
Message | string | Description of the validation error |
Type | string | Type of validation error |
Response JSON
Success Response - This is a sample response for successful API requests.
{
"StatusCode": 200,
"StatusName": "Ok",
"StatusMessage": "Successful API call"
"SubmissionId": "efacde0b-93e4-4327-84f5-f003b14fdc47",
"Form1099MiscRecords": [
{
"RecordId": "7629fc38-5a6f-4b51-842e-b3058bc5a94c",
"Message": "We've successfully received your request to generate PDF. You will be notified with the URL to download the PDF."
},
{
"RecordId": "c97de8be-f02a-455c-9c75-dc372da07cc6",
"Message": "We've successfully received your request to generate PDF. You will be notified with the URL to download the PDF."
}
],
"Errors": null
}