Actions48
- Article Actions
- Contact Actions
- Country Actions
- Credit Note Actions
- Delivery Note Actions
- Dunning Actions
- Down Payment Invoice Actions
- Event Subscription Actions
- File Actions
- Invoice Actions
- Order Confirmation Actions
- Payment Actions
- Payment Condition Actions
- Posting Category Actions
- Print Layout Actions
- Profile Actions
- Quotation Actions
- Recurring Template Actions
- Voucher Actions
- Voucherlist Actions
File → Download
AI-generatedSummary
Downloads a file from Lexware Office by its ID and returns it as binary data.
Inputs
- id (required) — ID of the file to download (from the File resource).
- binaryPropertyName — Name of the binary property where the downloaded file will be stored. Defaults to 'data'.
Output shape
An object with a json field containing the file ID and a binary field containing the file data under the property name specified by binaryPropertyName.
The
jsonoutput is{ id: <file-id> }. Thebinaryoutput is{ [<binaryPropertyName>]: <file-buffer> }.
Examples
Example 1: Download a file with ID 'abc123' and store it in the default binary property 'data'.
Resource: File, Operation: Download, ID: abc123, Binary Property: data