Skip to main content
Version: 1.7.3

GetPdf

GET Form1099SA/GetPDF 
Run in Postman

Request Params

FieldTypeDescription
SubmissionIdGuidUnique identifier of a submission
RecordIdsGuid[]Optional Unique identifier of a records.

Request Params

Form1099SA/GetPdf?SubmissionId=556e41eb-0ccb-4aeb-b486-19743d3a1c32

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.
Form1099SARecordsobject[]Collection of Form 1099SA records for which the PDF will be successfully delivered
    RecordIdguidUnique identifier of a record
    MessagestringProvides additional information regarding the PDF delivery.
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": "556e41eb-0ccb-4aeb-b486-19743d3a1c32",
"Form1099SARecords": [
{
"RecordId": "11944cac-7aa0-47e8-951c-5454e38cda4e",
"Message": "We've successfully received your request to generate PDF. You will be notified with the URL to download the PDF."
}
],
"Errors": null
}