RequestDraftPdfUrl
This API request will return the Draft PDF of the forms that are not transmitted yet for review purpose. The draft PDF will have copy A of the form with For Review Only watermark text.
Note: You can only retrieve PDF of a single record/form using this method.
How does it works?
-
Call the [POST] Form1099PATR/RequestDraftPdfUrl endpoint. You will need to supply the following parameters:
-
Access Token in the header as Bearer Token (Generated using TaxBandits OAuth authentication API)
-
Request Parameters: 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.
- Recipient Reference - Use the recipient reference PayeeRef or RecipientId or TIN.
- Tax Year - Tax year of the form you are requesting the PDF.
-
POST Form1099PATR/RequestDraftPdfUrl
Request Body
Field | Type | Description |
---|---|---|
RecordId | Guid | Optional Specify the RecordId of the return |
TINMaskType | string | Optional TIN Mask type on the TIN printed on the PDF Allowed values: "MASKED", "UNMASKED" |
TaxYear | string | Optional Tax Year of the return. Specify only if you do not have the RecordId . Allowed values: "2022","2023" |
Business | object | Optional Collects the Business identifier TIN or TBS Business Id or PayerRef. This object information is required only if you do not have the RecordId |
BusinessId | Guid | Optional TaxBandits Unique Business Identifier. This ID is generated by TaxBandits after you create a business in your account using the Business endpoint. |
PayerRef | string | Optional Unique payer identifier assigned by the client. Size Range: 1 to 50 |
TINType | string | Optional TIN type of the Business TIN. Use this as an alternative for BusinessId or PayerRef. Allowed values: "SSN,EIN" |
TIN | string | Optional Taxpayer Identification Number. Use this as an alternative for BusinessId or PayerRef. Size Range: 9 to 11 |
Recipient | object | Optional Collects the recipient's unique identifier. This object information is required only if you do not have the RecordId |
PayeeRef | string | Optional An unique identifier for each recipient set by the client. Size Range: 1 to 50 |
RecipientId | Guid | Optional Unique Recipient Identifier generated by TaxBandits |
TINType | string | Optional TIN type of the Recipient’s TIN. Use this as an alternative for RecipientId or PayeeRef. Allowed values: "SSN,EIN" |
TIN | string | Optional Taxpayer Identification Number. Use this as an alternative for RecipientId or PayeeRef. |
Request JSON
- Sample 1
- Sample 2
With just the RecordId
{
"TaxYear": null,
"RecordId": "7dc8bea4-97b1-42fd-adf4-ac8537abbeb1",
"Business": null,
"Recipient": null
}
With No RecordId
{
"TaxYear": "2023",
"RecordId": null,
"TINMaskType": "MASKED",
"Business": {
"BusinessId": "94B6214D-8DCA-490C-8FC3-602840B439B5",
"PayerRef": null,
"TINType": null,
"TIN": null
},
"Recipient": {
"RecipientId": "6DDFFB5A-565F-402D-8602-7ECD917CEC04",
"PayeeRef": null,
"TINType": null,
"TIN": null
}
}
Response Body
Field | Type | Description |
---|---|---|
RecordId | Guid | Unique identifier of the record |
RecipientId | Guid | Unique Recipient Identifier generated by TaxBandits |
PayeeRef | string | An unique identifier for each recipient set by the client. |
DraftPdfUrl | string | URL of the Draft PDF |
DraftPdfPath | string | Storage path of the draft PDF |
Errors | object[] | Shows detailed error information |