v1

latestOpenAPI 3.1.0AGPL-3.0 license2026-07-1210336283.6 KB
Files

Download invoice PDF

Downloads an invoice as a PDF. Can be accessed with an invoice ID (requires team file key via fk query parameter) or invoice token (public access).

get/files/download/invoice

Query parameters

idstring uuid

Invoice ID (UUID). Requires team file key (fk) query parameter for authentication.

Example:b3b7c1e2-4c2a-4e7a-9c1a-2b7c1e24c2a4

Invoice ID (UUID). Requires team file key (fk) query parameter for authentication.

fkstring

Team file key for authenticated invoice access. Required when using invoice ID. This key is returned in the user data response (GET /users/me) as the fileKey field.

Example:eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...

Team file key for authenticated invoice access. Required when using invoice ID. This key is returned in the user data response (GET /users/me) as the fileKey field.

tokenstring

Invoice access token for public access. When used alone (without id), allows public access to the invoice.

Example:eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...

Invoice access token for public access. When used alone (without id), allows public access to the invoice.

previewboolean nullable

If true, the PDF will be displayed inline. If false, it will be downloaded.

If true, the PDF will be displayed inline. If false, it will be downloaded.

type'invoice' | 'receipt'

Type of document to download. Use 'receipt' to download a receipt for paid invoices.

Example:invoice

Type of document to download. Use 'receipt' to download a receipt for paid invoices.

Response

Invoice PDF