GetPdf
GET Form1099SA/GetPDF
Request Params
Field | Type | Description |
---|---|---|
SubmissionId | Guid | Unique identifier of a submission |
RecordIds | Guid[] | Optional Unique identifier of a records. |
Request Params
Form1099SA/GetPdf?SubmissionId=556e41eb-0ccb-4aeb-b486-19743d3a1c32
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. |
Form1099SARecords | object[] | Collection of Form 1099SA 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 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": "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
}