GetPDF

TaxBandits provides PDF copies of the tax Return using this API Endpoint. The PDFs can be used for any additional review and approval from your business’ side and it can be distributed to the Employees before the SSA accepts them.

GET FormW2C/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 Employee's SSN on the W-2C PDF. MASKED - The Employee's SSN will be masked in the PDF. Only last 4 digits of the SSN can be read. UNMASKED - The Employee's SSN will not be masked in the PDF. To protect the PII information of the Employee, the PDF with Unmasked SSN is password protected. Use the Employee's SSN (password) to open the protected file. BOTH - Two PDF's will be delivered for each Employee. One with Masked SSN and the other with Unmasked SSN. The PDF with Unmasked SSN will be password protected. Allowed values: "MASKED", "UNMASKED", "BOTH"

Request Params

"FormW2C/GetPDF?SubmissionId=000e9b21-c0fd-421c-867e-93ef54d37b33&RecordIds=f03875e4-e6b5-4cf4-828e-8ca026f0e5e0&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
FormW2CRecords	object[]	Collection of Form W-2C 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": "000e9b21-c0fd-421c-867e-93ef54d37b33",
 "FormW2CRecords": [
   {
     "RecordId": "f03875e4-e6b5-4cf4-828e-8ca026f0e5e0",
     "Message": "We've successfully received your request to generate PDF. You will be notified with the URL to download the PDF."
   }
 ],
 "Errors": null
}