Payslip PDFs in PHP

Why payslips become PDFs

A payslip is a personal financial record an employee keeps, uses to apply for credit, and expects to be able to open years later. That is the difference between a document and a view of a database, and it is why HR and payroll teams keep asking for this.

What a payslip has to carry

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

• gross pay, itemised by basic, overtime and any allowances
• each deduction named separately with its own amount
• net pay, which is the number the employee checks first
• year-to-date totals for gross, tax and net
• the pay period and the payment date, which are not the same day
• the employee identifier and tax reference

The PHP implementation

cURL ships with the runtime, so this adds no dependency. The render happens in a controller action that echoes the body with a PDF Content-Type, and you write the body with readfile and the right Content-Type header.

<?php
function payslipPdf(string $id): void {
    $html = renderPayslip($id);

    $ch = curl_init('https://api.pdfpipe.xyz/v1/pdf');
    curl_setopt_array($ch, [
        CURLOPT_POST           => true,
        CURLOPT_RETURNTRANSFER => true,  // without this the body goes to stdout
        CURLOPT_HTTPHEADER     => [
            'Authorization: Bearer ' . getenv('PDFPIPE_KEY'),
            'Content-Type: application/json',
        ],
        CURLOPT_POSTFIELDS => json_encode([
            'html'    => $html,
            'options' => ['format' => 'A4', 'printBackground' => true],
        ]),
    ]);

    $pdf = curl_exec($ch);
    if ($pdf === false) {
        throw new RuntimeException('render failed: ' . curl_error($ch));
    }
    curl_close($ch);

    header('Content-Type: application/pdf');
    header('Content-Disposition: inline; filename="' . $id . '.pdf"');
    echo $pdf;
}

The CSS that makes a payslip page correctly

The layout problem specific to this document is that gross, deductions and net must be visible together without scrolling or breaking, on one page, every time. These rules handle it.

/* Gross, deductions and net have to be visible together. One page,
   every time, regardless of how many deduction lines there are. */
.payslip { break-inside: avoid; }
.summary { break-inside: avoid; }

@page { size: A4; margin: 15mm; }

What goes wrong in PHP

allow_url_fopen is off on plenty of shared hosts, so file_get_contents silently fails while cURL keeps working. Set CURLOPT_RETURNTRANSFER or the body goes to stdout and corrupts the response.

What people try first

Most PHP projects reach for dompdf, which is pure PHP and therefore installs cleanly, but implements its own layout engine and does not support modern CSS. 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 payslip lives afterwards

Rendering is the short part. Payslips are personal financial records the employee will need for credit applications and tax filings for years. Employers commonly retain them for six years, and employees expect to be able to download an old one long after they have left.

Getting the document right

• Check net pay and the deduction breakdown, which is what an employee checks first and complains about immediately.
• Generation is triggered by a payroll run, producing every employee's document at once, so size the timeout for that path rather than for a health check.
• This is a batch shape: render the run through the batch endpoint rather than firing thousands of individual requests.
• 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 PHP documents, and the same payslip in other stacks.