Skip to main content
Version: 1.7.3

RequestDraftPdfUrl

POST Form1099GCorrection/RequestDraftPdfUrl 
Run in Postman

Request Body

FieldTypeDescription
TaxYearstringOptional Tax year of Form 1099 G Correction to be filed.
Allowed values:"2023"
RecordIdGuidOptional Specify the RecordId of the return.
TINMaskTypestringOptional TIN Mask type on the TIN printed on the PDF.
Allowed values: "MASKED", "UNMASKED"
BusinessobjectOptional Collects the Business identifier TIN or TBS Business Id or PayerRef. This object information is required only if you do not have the RecordId
    BusinessIdGuidOptional Unique identifier of a Business.
    PayerRefstringOptional An unique identifier for each payer completing their information. This identifier can be used in future references of the payer in the API.
Size Range: 50
    TINTypestringOptional TIN type of the business.
    TINstringOptional payer’s TIN.
RecipientobjectOptional Collects the recipient's unique identifier. This object information is required only if you do not have the RecordId.
    PayeeRefstringOptional An unique identifier for each recipient set by the client.
Size Range: 1 to 50
    RecipientIdGuidOptional Unique identifier of the Recipient.
    TINTypestringOptional TIN type of the Recipient’s TIN. Use this as an alternative for RecipientId or PayeeRef.
Allowed values:"SSN", "EIN"
    TINstringOptional Taxpayer Identification Number. Use this as an alternative for RecipientId or PayeeRef.
Size Range: 9-11

Request JSON

{
"TaxYear": "2023",
"TINMaskType": "masked",
"RecordId": "9a00213a-addf-4e79-8f10-ddf98e77abf1",
"Business": {
"BusinessId": null,
"PayerRef": null,
"TINType": null,
"TIN": null
},
"Recipient": {
"RecipientId": null,
"PayeeRef": null,
"TINType": null,
"TIN": null
}
}

Response Body

FieldTypeDescription
RecordIdGuidUnique identifier of the record
RecipientIdGuidUnique Recipient Identifier generated by TaxBandits
PayeeRefstringAn unique identifier for each recipient set by the client.
DraftPdfUrlstringURL of the Draft PDF
DraftPdfPathstringStorage path of the draft PDF
Errorsobject[]Shows detailed error information
    IdstringReturns the validation error code
    NamestringName of the validation error
    MessagestringDescription of the validation error

Response JSON

Success Response - This is a sample response for successful API requests.

 {
"RecordId": "5ce0a501-ddcd-4b23-af7c-c836bc434bda",
"RecipientId": "ba15c63a-e191-4dbc-9156-457f0980052e",
"PayeeRef": null,
"DraftPdfUrl": "https://expressirsforms.s3.us-east-1.amazonaws.com/pdfs/c2d66a8c-3cf3-4dbc-9095-38b92fc58866/0927361d-25ec-47d5-9c37-7a239ec6a2fa/1099/19455581/d/copy_tbs_wm_1up_9455960000.pdf",
"DraftPdfPath": "pdfs/c2d66a8c-3cf3-4dbc-9095-38b92fc58866/0927361d-25ec-47d5-9c37-7a239ec6a2fa/1099/19455581/d/copy_tbs_wm_1up_9455960000.pdf",
"Error": null
}