UploadAttachment
Need to send the yearly transaction details or any additional attachment with the 1099 to your recipients? With the TaxBandits API, you can furnish additional documents to your recipients along with their 1099 forms.
- Create the 1099 Form: Start by creating a 1099 form for the recipient.
- Upload Transaction Documents: Use the UploadAttachment endpoint against each form to upload any additional documents related to that recipient.
- Transmit & Distribute: After uploading, use the Transmit endpoint. TaxBandits will distribute the 1099 form and attached documents to the recipient, provided that you’ve opted for Postal Mailing and/or Online Access.
Best Practices
- Ensure Postal Mailing is enabled for each recipient.
- Verify that TIN details in the attachments are masked before uploading to TaxBandits.
- Provide either PDFByteArray or FilePath for each RecordId. If both are provided, an error will occur. If using FilePath, ensure the file is accessible and downloadable.
- Call the UploadAttachment endpoint for each record before transmitting the forms. Attachments cannot be uploaded once the forms are transmitted.
- If multiple PDFs are uploaded for a single RecordID, the latest upload will replace the previous ones.
- Each submission can include up to 100 PDFs or a cumulative total of 100 MB in ByteArrays.
- Each ByteArray must not exceed 2 MB.
POST Form1099MISC/UploadAttachment
Request Body
Field | Type | Description |
---|---|---|
SummaryAttachment | Object[] | Object to get the attachment details |
RecordID | Guid | Unique identifier of the records given by TaxBandits |
PDFByte | ByteArray | Byte array of the pdf document |
FilePath | String | File path of the pdf document |
Request JSON
{
"SummaryAttachment": [
{
"RecordID": "e88e7f1d-7ae5-43b6-99f6-38d85664035a",
"PDFByte": "JVBERi0xLjMKJcOHw6zCj8KiCjEgMCBvYmoKPDwvVHlwZSAvQ2F0YWxvZwovUGFnZXMgMiAwIFIKPj4KZW5kb2JqCgoyIDAgb2JqCjw8L1R5cGUgL1BhZ2VzCj4+CmVuZG9iagoKMyAwIG9iago8PC9Qcm9kdWNlciAoXS5jZr7J2RzsWMGZesbjnpitsebz7uIEZ5dbRhmC/A6w6QJx87yIZn+lw6h212zv0LgpCj4+CmVuZG9iagoKNCAwIG9iago8PC9GaWx0ZXIgL1N0YW5kYXJkCi9WIDIKL1IgMwovUCAtMTg1MgovTyA8MzY0NTFCRDM5RDc1M0I3QzFEMTA5MjJDMjhFNjY2NUFBNEYzMzUzRkIwMzQ4QjUzNjg5M0UzQjFEQjVDNTc5Qj4KL1UgPDREM0ZCQTBEQTkzNDdGRTdBMDhBRDk0Mzk2OEJBNzM2MzE0MTU5MjY1MzU4OTc5MzIzODQ2MjY0MzM4MzI3OTU+Ci9MZW5ndGggMTI4Cj4+CmVuZG9iagoKeHJlZgowIDUKMDAwMDAwMDAwMCA2NTUzNSBmIAowMDAwMDAwMDE5IDAwMDAwIG4gCjAwMDAwMDAwNjggMDAwMDAgbiAKMDAwMDAwMDEwMiAwMDAwMCBuIAowMDAwMDAwMTg2IDAwMDAwIG4gCnRyYWlsZXIKPDwvU2l6ZSA1Ci9Sb290IDEgMCBSCi9JbmZvIDMgMCBSCi9JRCBbPDU1MUQwRTI4MOUE+XQovRW5jcnlwdCA0IDAgUgo+PgpzdGFydHhyZWYKMzk2CiUlRU9GCg==",
"FilePath": null
},
{
"RecordID": "04ec74ea-9099-42a0-9a64-710a4d7eec37",
"PDFByte": null,
"FilePath": "https://amazonaws.com/pdfs/a570efbd-740f-4ae2-bfe7-26356cd85148.pdf"
}
]
}
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. |
SuccessRecords | Object | Object contains the success records |
RecordID | Guid | Unique Identifier of the records generated by TaxBandits |
Info | String | Success records information |
ErrorRecords | Object | Object contains the error records. |
RecordID | Guid | Unique Identifier of the records generated by TaxBandits |
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. |
Response JSON
{
"StatusCode": 200,
"StatusName": "Ok",
"StatusMessage": "Successful API Call",
"SuccessRecords": [
{
"RecordID": "e88e7f1d-7ae5-43b6-99f6-38d85664035a",
"Info": "Attachment Uploaded Successfully"
},
{
"RecordID": "e88e7f1d-7ae5-43b6-99f6-38d85664035a",
"Info": "Attachment Uploaded Successfully"
}
]
"ErrorRecords": null
}