Actions58
- Client Actions
- Company Actions
- Contact Actions
- Expense Actions
- Expense Category Actions
- Invoice Actions
- Project Actions
- Project Task Assignment Actions
- Project User Assignment Actions
- Report Actions
- Task Actions
- Time Entry Actions
- User Actions
Invoice → Download PDF
AI-generatedSummary
Download the PDF file of an invoice using its client key obtained from the invoice object.
Inputs
- Client Key (required) — The client_key of the invoice; this is used to identify and download the specific invoice PDF. It can be retrieved from the invoice object via the "Get" operation.
Output shape
a single binary file representing the PDF of the invoice.
The output includes binary data of the invoice PDF named as 'invoice-{clientKey}.pdf'. You must provide the client key exactly as retrieved to successfully download the file.
Examples
Example 1: Download an invoice PDF after retrieving an invoice
First use the 'Get' operation on the 'Invoice' resource to fetch an invoice and extract its 'client_key'. Then use this operation with that client key to download the corresponding invoice PDF.