elghaied

payload invoicepdf

by elghaied
Other
v3
^3.79.0
MIT

Overview

Summary generated from the README

Adds invoices and quotes collections, a shop-info global and PDF generation using React PDF templates. Documents can be emailed with a PDF attachment or a secure link, and clients can accept or decline quotes. Requires Payload 3.79 or newer and a media collection with uploads enabled.

Features

  • Four built-in PDF templates plus support for custom JSX templates
  • Auto-numbered invoices and quotes with line items, tax and due dates
  • Email sending with PDF attachments or live links, with send history
  • Quote acceptance link that creates a draft invoice when accepted
  • Customer and product autofill from existing collections
  • Stored PDF version history and admin sidebar actions

Use cases

  • Generate and email branded PDF invoices from the Payload admin
  • Send quotes to clients and convert accepted quotes into draft invoices
  • Autofill client and line item details from existing customer and product collections

From the author

Payload CMS 3.x plugin for invoice and quote management with PDF generation, email sending, quote acceptance workflows, and a rich admin UI

Installation

npm i payload-invoicepdf

9

Stars

1

Forks

0

Open Issues

7 months ago

Last Updated

0

Weekly Downloads

v1.0.0

npm Version

526.3 KB

Unpacked Size

1

Dependencies

GitHub stars

Trends appear after 7 days of data. Daily snapshots have not started yet.

npm weekly downloads

Trends appear after 7 days of data. Daily snapshots have not started yet.

Each point is npm's rolling 7-day download count.

Health Score

40/100Fair

Composite score based on GitHub activity, stars, npm downloads, publish recency, dependency count, and package size.

Badge for your README

Payload Directory health badge
Markdown
[![Payload Directory](https://payloaddirectory.dev/badge/1178652475-root.svg)](https://payloaddirectory.dev/plugins/1178652475-root)
HTML
<a href="https://payloaddirectory.dev/plugins/1178652475-root"><img src="https://payloaddirectory.dev/badge/1178652475-root.svg" alt="Payload Directory"></a>
Updated Mar 11, 2026Created Mar 11, 2026Published Mar 11, 2026

README

payload-invoicepdf

Professional PDF invoices and quotes for Payload CMS

npm version license Payload 3.x


A Payload CMS 3.x plugin that adds complete invoice and quote management — JSX-based PDF templates, email sending, quote acceptance workflows, customer autofill, and a rich admin UI — out of the box.

Features

  • PDF Generation — 4 built-in templates (Classic, Modern, Minimal, Bold) rendered with @react-pdf/renderer. Create custom templates with JSX.
  • Invoices & Quotes — Full collections with auto-numbering (INV-2026-0001), status tracking, line items, tax calculation, and due dates.
  • Email Sending — Send invoices/quotes via email with PDF attachments or live document links. Tracks send history per document.
  • Quote Acceptance — Clients receive a secure link to view, accept, or decline quotes. Accepting auto-creates a draft invoice.
  • Customer Autofill — Connect your existing customer collection. Select a customer and client fields fill automatically.
  • Product Autofill — Link your product catalog. Add a product to a line item and description + price populate instantly.
  • PDF History — Every generated PDF is stored and versioned. Browse and download previous versions from the admin.
  • Admin UI — Tabbed document views, sidebar actions (download, generate, send, convert), email composer drawer, and related document links.

Screenshots

Quote Management

Quote document view with client details, actions sidebar, and related invoices

PDF History

PDF version history with download and delete options

Send Email Drawer

Email composer with delivery type toggle, template selection, and PDF attachment

Send History

Send history tab showing all emails sent for a document

Quote Acceptance Page

Client-facing quote page with Accept and Decline buttons

Email Template

Professional email received by client with View Quote button and PDF attachment

Quick Start

npm install payload-invoicepdf
# or
pnpm add payload-invoicepdf
// payload.config.ts
import { invoicePdf, builtInTemplates } from 'payload-invoicepdf'

export default buildConfig({
  // ...your config
  plugins: [
    invoicePdf({
      productCollection: 'products',
      productFieldMapping: {
        name: 'name',
        price: 'price',
      },
      templates: builtInTemplates,
    }),
  ],
})

That's it. You now have invoices and quotes collections with PDF generation, a shop-info global for your company details, and sidebar buttons for downloading, generating, and emailing documents.

Built-in PDF Templates

TemplateStyle
ClassicTraditional business invoice with clean lines
ModernSleek, minimal layout with accent colors
MinimalUltra-clean whitespace-heavy design
BoldStrong color header, high contrast

Select a template per document, or set a default. Build your own with @react-pdf/renderer — see the Custom Templates Guide.

Documentation

GuideDescription
Getting StartedInstallation, configuration, and your first invoice
Configuration ReferenceAll config options with examples
PDF TemplatesBuilt-in templates and how to select them
Custom TemplatesBuild your own PDF and email templates with JSX
Email SendingEmail setup, templates, and send history
Quote AcceptanceSecure link workflow for client quote responses
Customer AutofillConnect your customer collection for autofill

Requirements

  • Payload CMS ^3.79.0
  • Node.js ^18.20.2 or >=20.9.0
  • A media collection with uploads enabled (or specify a custom mediaCollection)

License

MIT

Similar plugins