The response of the API request will return the Draft PDF for review purpose.This method can be used to retrieve PDF for a single record/form.
The PDF will be returned in the response for the Forms that are not yet Transmitted in TaxBandits.
This method will only provide the Copy A of the Form W2C and it will have a watermark "For Review only" on it.
How does it work?
The first step is to call the Auth method to get the access token. This access token must be supplied in the request header as the 'Bearer' token. Refer to OAuth 2.0 Authentication for more information on JWT authentication and how to integrate with the subsequent requests.
The second step is to call the Create endpoint FormW2C/Create to create a return in TaxBandits. Store the RecordId of the W2C form that is generated by TaxBandits and returned in the Response.
Next, call the [POST] FormW2C/RequestDraftPdfUrl endpoint. You will need to supply the following parameters:
Access Token in the header as Bearer Token (Generated using TaxBandits OAuth Authentication API)
Form reference (RecordId) - Specify the RecordId for the form you need the Draft PDF form. If you do not have the RecordId, then you request the PDF using the following parameters
- Business Reference - Use the business reference PayerRef or Businessid or TIN
- Employee Reference - Use the employee reference PayeeRef or EmployeeId or TIN
- Tax Year - Tax year of the form you are requesting the PDF for.
Allowed values: "MASKED", "UNMASKED"
Size Range: 1 to 50
Size Range: 9 to 11
Size Range: 9 to 11
|RecordId||Guid||Unique identifier of the record|
|EmployeeId||Guid||Unique Employee Identifier generated by TaxBandits|
|DraftPdfUrl||string||URL of the Draft PDF|
|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|
Request JSON 1: With just the RecordId
Response JSON 1
Request JSON 2: With just the RecordId
Response JSON 2