PDFs and sending documents

Open or download one document as a PDF, zip up the ones you ticked or a whole quarter by filter, or email them to the customer.

Invoices, estimates, proposals, credit notes and contracts can all be turned into a PDF. It carries your logo, your company details and your terms, in the currency the document was raised in. Everything on this page works through the same record scope as the lists: what you can download is exactly what you could already open, and a document outside that is answered as if it did not exist.

One document

The file is named after the kind of document and its number — for example estimate-est-000123.pdf — so it can be found again in a downloads folder. It needs the view right for that kind of document.

The ones you ticked

Three estimates ticked, and the bar offering Download PDFs, Email to the customer and Delete. Three estimates ticked, and the bar offering Download PDFs, Email to the customer and Delete.

On the invoice or estimate list, tick the rows and a bar appears above them.

The covering email is short — the document is attached, reply with any questions — and it is written in the customer's own language, like the PDF. When the document was issued by a second company it is signed off with that company's name. When it is done you are told how many messages went, and how many documents had nobody to send to; a customer with no contact carrying an email address is reported rather than silently skipped.

Only what you could already open. Both actions re-check every selected document against your own permissions before doing anything, so a bulk export can never include a document your role does not let you see. If none of the ticked ones are yours, you are told so and nothing is made.

Export PDFs: a whole quarter at once

Export PDFs: choose the documents by type, date, status and customer tag, then count them and download the zip. Export PDFs: choose the documents by type, date, status and customer tag, then count them and download the zip.

The accountant's request at the end of a quarter — "every invoice from July to September, as PDFs" — is two hundred ticks on a list. Sales & Invoicing → Export PDFs makes it a date range and a button. The same screen is under Export → PDFs in a zip… on the invoice, estimate, proposal, credit note and contract lists, already set to that kind of document — which is how somebody who cannot see invoices reaches it.

Export on the estimates list, with PDFs in a zip… at the foot. Export on the estimates list, with PDFs in a zip… at the foot.
  1. Choose the Document type: invoices, estimates, proposals, credit notes or contracts — only the kinds you may view are offered. Changing it reloads the screen.
  2. Narrow it with Dated from and Dated to (the document's own date; a contract's start date), Status (not for contracts, whose state is worked out from their dates and signatures rather than stored), Customer tag, and for invoices Paid with — invoices with at least one payment recorded that way. Contracts in the trash are never included.
  3. Press Count them. The right-hand side says how many documents match. Clear takes the filters off.
  4. Press Download zip. The PDFs are the same ones the PDF buttons give, oldest first. A large zip can take a minute to prepare.
Large selections come in parts. Every PDF is drawn afresh, so a zip holds at most 100. When more match, the screen offers Part 1 (1–100), Part 2 (101–200) and so on; download each in turn. Each file's name says which part it is.

Documents carry no tags of their own, so the tag filter uses the tags on each document's customer; a proposal addressed to a lead rather than a customer is left out when a tag is chosen. The screen needs the view right for at least one of the five kinds, and asking for a kind you may not view is refused rather than swapped for another. The sidebar entry itself is shown to people who can view invoices.

The zip needs PHP's zip extension. Without it the screen says so, and neither this screen nor Download PDFs can bundle documents. Single PDFs still work. Ask your host to enable zip.

Sending one to a customer

Customers can download their own copy from the portal — every invoice, estimate and proposal they can see has a Download PDF button, unless you have switched that off for estimates and proposals (Settings → Estimates & proposals). Drafts are not listed there and cannot be reached by guessing an address either.

What appears on a PDF

A PDF is written in the customer's own language (see Languages): the headings, month names and text direction follow it, whoever downloads or sends the document. Dates use the workspace's date format and time zone.

Contract PDFs

A contract's page has Download PDF, and so does the contract in the customer portal. The PDF shows the issuing company and the customer side by side, the type, start and end dates and value, the custom fields marked for PDFs, the agreed wording, and — once the contract is signed — every signature with the name, date and IP address it was signed from.

Staff need Contracts: view, and see only the contracts their scope lets them open. In the portal a contact can download their own company's contracts, but not one that is hidden from the client or in the bin. Many contracts at once, as a zip, come from Export PDFs (Export → PDFs in a zip… on the contracts list).

Images in the wording. An image uploaded into the contract wording is embedded in the PDF. An image linked from another website is left out (its description is printed in its place): fetching it would mean the server downloading something from the internet every time a PDF is made.

Addresses on this page

For reference and for anyone scripting against the panel. Everything here needs somebody signed in to the workspace whose role allows it; anybody else is refused.

MethodAddressWhat it does
GETadmin/pdf/{kind}/{id}One document's PDF, shown in the browser. kind is invoice, estimate, proposal, credit_note or contract.
GETadmin/pdf/{kind}/{id}/downloadThe same PDF as a file download.
POSTadmin/pdf/{kind}/bulkThe ticked documents (ids[], up to 100) as one zip. Used by the list's bulk bar.
POSTadmin/pdf/{kind}/emailEmails the ticked documents (ids[], up to 100) to their customers. Used by the list's bulk bar.
GETadmin/document-pdfsThe Export PDFs screen, with kind, from, to, status, tag and method.
POSTadmin/document-pdfsDownloads one part of the matching documents as a zip.