Purchase order PDFs in Symfony

Why purchase orders become PDFs

A purchase order is the document a supplier's accounts team matches an invoice against, and it travels by email between two organisations that share no system. That is the difference between a document and a view of a database, and it is why procurement teams keep asking for this.

What a purchase order has to carry

Before any of the code below matters, the template has to produce a document that is actually a purchase order. These are the fields that make it one, and the ones a reader or an auditor will look for first.

• the PO number, which the supplier invoice must quote back
• the ordering entity and the ship-to address, which are often different
• the bill-to address and any cost centre or GL code
• each line with the agreed price, not the supplier list price
• the delivery date required, and the approval reference

Turning your Twig template into a document

You already have the markup. $this->renderView("invoice/pdf.html.twig", $data) gives you it as a string, which is the only input the render needs. Twig's asset() reads from the request context. In a console command or a message handler there is no request, so the base URL comes out empty and the paths in your markup are relative to nothing.

The Symfony implementation

HttpClientInterface is the client most projects here already have. The render happens in a controller returning StreamedResponse, and you wrap the response stream in a StreamedResponse.

<?php
// src/Controller/PurchaseOrderController.php

namespace App\Controller;

use Symfony\Component\HttpFoundation\StreamedResponse;
use Symfony\Contracts\HttpClient\HttpClientInterface;

class PurchaseOrderController extends AbstractController
{
    public function __construct(private HttpClientInterface $client) {}

    #[Route('/purchase-orders/{id}.pdf', name: 'purchase_order_pdf')]
    public function pdf(PurchaseOrder $purchase_order): StreamedResponse
    {
        $html = $this->renderView('purchase_order/pdf.html.twig', ['purchase_order' => $purchase_order]);

        $upstream = $this->client->request('POST', 'https://api.pdfpipe.xyz/v1/pdf', [
            'auth_bearer' => $this->getParameter('pdfpipe.key'),
            'json' => [
                'html' => $html,
                'options' => ['format' => 'A4', 'printBackground' => true],
            ],
            'timeout' => 60,
        ]);

        // The transfer happens here, on first read, not on request() above.
        return new StreamedResponse(
            function () use ($upstream) {
                foreach ($this->client->stream($upstream) as $chunk) {
                    echo $chunk->getContent();
                }
            },
            200,
            ['Content-Type' => 'application/pdf'],
        );
    }
}

The CSS that makes a purchase order page correctly

The layout problem specific to this document is that delivery and billing addresses sit alongside a line item table, and both must stay on the first page where a supplier looks for them. These rules handle it.

/* Backgrounds are dropped unless printBackground is set on the
   request, which is the usual reason a document renders in plain
   black and white when it looked right in the browser. */
@page {
  size: A4;
  margin: 18mm 16mm;
}

table { break-inside: avoid; }
h2    { break-after: avoid; }

What goes wrong in Symfony

Symfony's HttpClient is lazy. request() returns before the response arrives, and the actual transfer happens when you first read the content. That means your timeouts and your try/catch have to be around the read, not around the call, or a failed render surfaces somewhere unexpected.

What people try first

Most Symfony projects reach for KnpSnappyBundle, a wrapper around the same wkhtmltopdf binary, with the same requirement that the binary exists everywhere the app runs. That works until it is running on more than one machine, at which point the browser becomes the thing you operate rather than the thing you use.

Where the purchase order lives afterwards

Rendering is the short part. A PO is retained alongside the invoice it authorised, because the pair is what an auditor matches. In practice it lives in the procurement system for as long as the supplier relationship does, which is longer than most teams plan for.

Getting the document right

• Check the PO number, because an invoice quoting the wrong one will not be paid.
• Generation is triggered by an approval completing in a procurement workflow, so size the timeout for that path rather than for a health check.
• These are produced one at a time by a person who is waiting, so latency is felt directly.
• Backgrounds are painted by default here, so a design that uses colour needs nothing set. Only an explicit print_background of false turns them off.

Frequently asked

Related

Other Symfony documents, and the same purchase order in other stacks.