FireDAC Components for Xero

Build 23.0.8839


Downloads a specified document in PDF format from Xero.


Name Type Required Description
Table String True The table containing the document to be downloaded.

The allowed values are Invoices, CreditNotes, Quotes.

ObjectId String True The unique ID of the item to download as PDF.
DownloadPath String False The path of the file to be saved. Must be a path to a file, not just a directory.
TenantId String 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.

Copyright (c) 2024 CData Software, Inc. - All rights reserved.
Build 23.0.8839