jjsm01/kimai2
1
0
Fork 0
Code Issues Pull Requests Actions 2 Packages Projects Releases Wiki Activity

Invoice download via API (#5926)

Browse Source
This commit is contained in:
Kevin Papst
2026-04-27 17:08:38 +02:00
committed by GitHub
parent 20c7b03bd9
commit dabd63800f
5 changed files with 115 additions and 1 deletions
Download Patch File Download Diff File Expand all files Collapse all files

35
src/API/InvoiceController.php
View File

@@ -151,4 +151,39 @@ final class InvoiceController extends BaseApiController
return $this->viewHandler->handle($view);
}
/**
* Download invoice
*/
#[IsGranted('view_invoice', 'invoice')]
#[OA\Response(
response: 200,
description: 'Downloads the invoice document as an attachment. The content type depends on the configured invoice renderer.',
headers: [
new OA\Header(header: 'Content-Disposition', description: 'Attachment filename', schema: new OA\Schema(type: 'string')),
],
content: [
new OA\MediaType(mediaType: 'application/pdf', schema: new OA\Schema(type: 'string', format: 'binary')),
new OA\MediaType(mediaType: 'application/vnd.openxmlformats-officedocument.wordprocessingml.document', schema: new OA\Schema(type: 'string', format: 'binary')),
new OA\MediaType(mediaType: 'application/vnd.openxmlformats-officedocument.spreadsheetml.sheet', schema: new OA\Schema(type: 'string', format: 'binary')),
new OA\MediaType(mediaType: 'application/vnd.oasis.opendocument.spreadsheet', schema: new OA\Schema(type: 'string', format: 'binary')),
new OA\MediaType(mediaType: 'text/html', schema: new OA\Schema(type: 'string')),
new OA\MediaType(mediaType: 'application/xml', schema: new OA\Schema(type: 'string')),
new OA\MediaType(mediaType: 'text/xml', schema: new OA\Schema(type: 'string')),
new OA\MediaType(mediaType: 'application/octet-stream', schema: new OA\Schema(type: 'string', format: 'binary')),
]
)]
#[Route(path: '/{id}/download', name: 'download_invoice', requirements: ['id' => '\d+'], methods: ['GET'])]
public function downloadAction(Invoice $invoice, InvoiceService $service): Response
{
$file = $service->getInvoiceFile($invoice);
if (null === $file) {
throw $this->createNotFoundException(
\sprintf('Invoice file could not be found for invoice ID "%s"', $invoice->getId())
);
}
return $this->file($file->getRealPath(), $file->getBasename());
}
}

2
src/Entity/Invoice.php
View File

@@ -124,6 +124,8 @@ class Invoice implements EntityWithMetaFields
#[ORM\Column(name: 'invoice_filename', type: Types::STRING, length: 150, nullable: false)]
#[Assert\NotNull]
#[Assert\Length(min: 1, max: 150)]
#[Serializer\Expose]
#[Serializer\Groups(['Default'])]
#[Exporter\Expose(label: 'file', type: 'string')]
private ?string $invoiceFilename = null;
private bool $localized = false;