Statement PDFs in ASP.NET Core

Why statements become PDFs

A statement summarises a period that is now closed. Regenerating it later from live data would produce a different document, which defeats the point. That is the difference between a document and a view of a database, and it is why finance and account management keep asking for this.

What a statement has to carry

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

• the opening balance and the closing balance
• every transaction in the period with date, description and signed amount
• a running balance column, so a reader can find where a discrepancy starts
• the account identifier, usually masked
• the statement period, which must not overlap the previous one

Turning your Razor template into a document

You already have the markup. Await _razorRenderer.RenderViewToStringAsync("Invoice", model) gives you it as a string, which is the only input the render needs. Rendering a Razor view to a string outside the MVC pipeline needs an explicit ActionContext, which is why most projects end up with a small RazorViewToStringRenderer service. Write it once and inject it.

The ASP.NET Core implementation

IHttpClientFactory ships with the runtime, so this adds no dependency. The render happens in an action returning FileStreamResult, and you return File(stream, "application/pdf").

// Controllers/StatementController.cs
using System.Net.Http.Json;

[ApiController]
public class StatementController : ControllerBase
{
    private readonly IHttpClientFactory _factory;
    private readonly RazorViewToStringRenderer _razor;

    public StatementController(IHttpClientFactory factory, RazorViewToStringRenderer razor)
        => (_factory, _razor) = (factory, razor);

    [HttpGet("/statements/{id}.pdf")]
    public async Task<IActionResult> Pdf(string id, CancellationToken ct)
    {
        var statement = await _statements.FindAsync(id, ct);
        var html = await _razor.RenderViewToStringAsync("StatementPdf", statement);

        // From the factory. new HttpClient() per request exhausts sockets under
        // load, and the symptom only appears in production.
        var client = _factory.CreateClient("pdfpipe");

        var upstream = await client.PostAsJsonAsync("https://api.pdfpipe.xyz/v1/pdf", new
        {
            html,
            options = new { format = "A4", printBackground = true },
        }, ct);

        upstream.EnsureSuccessStatusCode();

        var stream = await upstream.Content.ReadAsStreamAsync(ct);
        return File(stream, "application/pdf", $"statement-{id}.pdf");
    }
}

The CSS that makes a statement page correctly

The layout problem specific to this document is that a long transaction table spanning many pages, needing repeated headers and a running balance that stays legible after a break. These rules handle it.

/* Line items run past one page. Repeat the header, keep the
   totals block whole, and never strand a single row. */
thead { display: table-header-group; }
tfoot { display: table-footer-group; }
tr    { break-inside: avoid; }

.totals {
  break-inside: avoid;
  break-before: auto;
}

@page {
  size: A4;
  margin: 18mm 16mm 22mm;
}

What goes wrong in ASP.NET Core

new HttpClient() per request exhausts sockets under sustained load, because each disposed handler leaves a connection in TIME_WAIT. Inject IHttpClientFactory. This is the most common .NET HTTP mistake that only appears in production.

What people try first

Most ASP.NET Core projects reach for PuppeteerSharp, which downloads and supervises a Chromium build from inside your own process, or QuestPDF, which is a fluent layout API rather than a way to render HTML you already have. 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 statement lives afterwards

Rendering is the short part. Statements are the document most often requested again years later, usually for a loan application or an audit. Regenerating one from current data would produce different figures, so the rendered file is the record and has to be stored as issued.

Getting the document right

• Check the closing balance, which has to reconcile with the transactions listed above it.
• Generation is triggered by the end of a billing or accounting period, 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 ASP.NET Core documents, and the same statement in other stacks.