Invoice PDFs in Ruby

Why invoices become PDFs

An invoice is a legal record of a demand for payment, and in most jurisdictions it has to be retained in a form that cannot change after issue. A page that re-renders from live data is not that. That is the difference between a document and a view of a database, and it is why finance teams and anyone billing customers keep asking for this.

What a invoice has to carry

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

• an invoice number that is sequential and never reused
• the issue date, and separately the payment due date
• supplier and customer legal names with addresses, not trading names
• tax registration numbers for both parties where the jurisdiction requires them
• per-line quantity, unit price, tax rate and line total
• the tax subtotal broken out by rate, then the gross total

The Ruby implementation

Net::HTTP ships with the runtime, so this adds no dependency. The render happens in a controller action using send_data, and you send_data with the right type and disposition.

require "net/http"
require "json"

class InvoicesController < ApplicationController
  def show
    html = render_to_string(template: "invoices/show", layout: "pdf")

    uri = URI("https://api.pdfpipe.xyz/v1/pdf")
    request = Net::HTTP::Post.new(uri)
    request["Authorization"] = "Bearer #{ENV.fetch('PDFPIPE_KEY')}"
    request["Content-Type"]  = "application/json"
    request.body = {
      html: html,
      options: { format: "A4", printBackground: true },
    }.to_json

    response = Net::HTTP.start(uri.hostname, uri.port, use_ssl: true) do |http|
      http.request(request)
    end

    # Net::HTTP hands back ASCII-8BIT. Do not re-encode it.
    send_data response.body,
              type: "application/pdf",
              disposition: "inline",
              filename: "#{params[:id]}.pdf"
  end
end

The CSS that makes a invoice page correctly

The layout problem specific to this document is that line items are unbounded, so the table has to break across pages while the totals block stays whole and the column headers repeat. 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 Ruby

Net::HTTP returns a String with ASCII-8BIT encoding. Do not run it through anything that assumes UTF-8, or the PDF arrives corrupted with no error anywhere to explain it.

What people try first

Most Ruby projects reach for wkhtmltopdf via wicked_pdf, which needs a system binary on every machine and is built on a Qt WebKit fork that stopped tracking the web years ago. 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 invoice lives afterwards

Rendering is the short part. Invoices are kept for the statutory retention period, which in most jurisdictions runs to six years or more. That means the file has to be stored, not regenerated, and the stored copy has to be the one that was sent.

Getting the document right

• Check the total. A rounding difference between what you display and what you charge is the kind of error that surfaces during an audit rather than on the day.
• Generation is triggered by an order completing, or a billing cycle closing, so size the timeout for that path rather than for a health check.
• Volume arrives in bursts, so queue the render rather than doing it inside the request that triggered it.
• 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 Ruby documents, and the same invoice in other stacks.