DownloadAttachment
Obtains an attachment from a specified document in Xero.
Input
Name | Type | Required | Accepts Output Streams | Description |
Table | String | True | False | The table containing the document with the attachment.
The allowed values are Invoices, Receipts, CreditNotes, BankTransactions, BankTransfers, Contacts, Accounts, ManualJournals. |
ObjectId | String | True | False | The unique ID of the item to obtain an attachment from. |
Filename | String | True | False | The name of the attachment to retrieve. |
DownloadPath | String | False | False | The path of the file to be saved. Must be a path to a file, not just a directory. |
FileStream | String | False | True | An instance of an output stream where file data is written to. Only used if DownloadPath is not provided. |
TenantId | String | False | False | The ID of the tenant to query instead of the connection tenant |
Result Set Columns
Name | Type | Description |
Success | String | A boolean indicating if the operation was successful. |
FileData | String | If the DownloadPath and FileStream are not provided, this contains the base64 encoded content of the file. |