Generate PDF

Generates a PDF document (invoice or quote) from structured data. Returns a downloadable PDF file.

POST /api/tools/generate-pdf

Generate PDF

cURL

curl --request POST \
  --url https://kliio.app/api/tools/generate-pdf \
  --header 'Authorization: <authorization>' \
  --header 'Content-Type: <content-type>' \
  --data '
{
  "title": "<string>",
  "number": "<string>",
  "date": "<string>",
  "clientName": "<string>",
  "clientEmail": "<string>",
  "partnerName": "<string>",
  "partnerEmail": "<string>",
  "amount": 123,
  "lineItems": [
    {
      "id": "<string>",
      "description": "<string>",
      "qty": {},
      "rate": {}
    }
  ],
  "dueDate": "<string>",
  "expiryDate": "<string>",
  "clientCompany": "<string>",
  "partnerCompany": "<string>",
  "logoUrl": "<string>",
  "subtotal": 123,
  "taxRate": 123,
  "currencySymbol": "<string>",
  "notes": "<string>",
  "terms": "<string>",
  "poNumber": "<string>",
  "discountAmount": 123,
  "shippingAmount": 123,
  "fontStyle": "<string>",
  "textScale": 123,
  "showBanner": true,
  "layoutType": "<string>",
  "bannerUrl": "<string>",
  "brandColor": "<string>",
  "isQuote": true,
  "quoteIntro": "<string>",
  "bodyMarkdown": "<string>",
  "requiresSignature": true,
  "paymentDueDays": 123
}
'

Headers

Authorization · string · required

Bearer YOUR_API_KEY

Content-Type · string · required

application/json

Body

title · string · required

Document type. Either Invoice or Quote.

number · string · required

Document number/ID (e.g., INV-0001 or QTE-0001).

date · string · required

Issue date in YYYY-MM-DD format.

clientName · string · required

Client’s full name.

clientEmail · string · required

Client’s email address.

partnerName · string · required

Your (partner’s) full name or business name.

partnerEmail · string · required

Your email address.

amount · number · required

Total amount to display on the document.

lineItems · array · required

Array of line items to display in the document.

Show Line item object

id · string

Unique identifier

description · string

Line item description

qty · string | number

Quantity

rate · string | number

Unit price/rate

dueDate · string

Due date in YYYY-MM-DD format. Used for invoices.

expiryDate · string

Expiry date in YYYY-MM-DD format. Used for quotes/proposals.

clientCompany · string

Client’s company name (optional).

partnerCompany · string

Your company name (optional).

logoUrl · string

URL or base64 data URI of your logo image.

subtotal · number

Subtotal amount. If omitted, it’s calculated from line items.

taxRate · number

Tax rate as percentage (0–100). Defaults to 20.

currencySymbol · string

Currency symbol (e.g., $, £, €). Defaults to $.

notes · string

Additional notes to display on the document.

terms · string

Terms and conditions text.

poNumber · string

Purchase Order number to display on the invoice.

discountAmount · number

Discount amount to subtract from subtotal.

shippingAmount · number

Shipping/delivery cost to add to the total.

fontStyle · string

Font style preset: elegant (default), modern, or classic.

textScale · number

Text size scale (0.8 to 1.2). Defaults to 1.

showBanner · boolean

Whether to show the hero banner image. Defaults to true.

layoutType · string

Layout style: standard (default) or overlay.

bannerUrl · string

URL of the hero banner image.

brandColor · string

Hex color code for accent color (e.g., #1D4D4F).

isQuote · boolean

Whether this is a quote (changes labels like “Valid until” vs “Due date”).

quoteIntro · string

Introduction text for quotes.

bodyMarkdown · string

Markdown content for the document body (e.g., scope of work).

requiresSignature · boolean

Whether the document requires a signature block.

paymentDueDays · number

Number of days until payment is due after signing (for quotes).

Response

Returns a binary PDF file with Content-Type: application/pdf.

Request Example

cURL

curl -X POST https://kliio.app/api/tools/generate-pdf \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "title": "Invoice",
    "number": "INV-0001",
    "date": "2025-03-20",
    "dueDate": "2025-04-20",
    "clientName": "Alice Johnson",
    "clientEmail": "[e-mail]",
    "clientCompany": "Acme Corp",
    "partnerName": "Your Agency",
    "partnerEmail": "[e-mail]",
    "partnerCompany": "Your Agency Ltd",
    "amount": 1500,
    "taxRate": 20,
    "currencySymbol": "$",
    "lineItems": [
      { "id": "1", "description": "Web Design", "qty": "1", "rate": "1200" },
      { "id": "2", "description": "Hosting (annual)", "qty": "1", "rate": "300" }
    ],
    "notes": "Payment within 7 days please.",
    "fontStyle": "elegant",
    "layoutType": "standard"
  }' -o invoice.pdf
```bash cURL (Quote)
curl -X POST https://kliio.app/api/tools/generate-pdf \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "title": "Quote",
    "number": "QTE-0042",
    "date": "2025-03-20",
    "isQuote": true,
    "clientName": "Bob Smith",
    "clientEmail": "[e-mail]",
    "partnerName": "Creative Studio",
    "partnerEmail": "[e-mail]",
    "amount": 2500,
    "lineItems": [
      { "id": "1", "description": "Brand Strategy", "qty": "1", "rate": "2500" }
    ],
    "bodyMarkdown": "### Scope of Work\n* Logo Design\n* Brand Guidelines",
    "requiresSignature": true,
    "paymentDueDays": 7
  }' -o quote.pdf

JavaScript

const res = await fetch('https://kliio.app/api/tools/generate-pdf', {
  method: 'POST',
  headers: {
    Authorization: 'Bearer YOUR_API_KEY',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    title: 'Invoice',
    number: 'INV-0001',
    date: '2025-03-20',
    dueDate: '2025-04-20',
    clientName: 'Alice Johnson',
    clientEmail: '[e-mail]',
    clientCompany: 'Acme Corp',
    partnerName: 'Your Agency',
    partnerEmail: '[e-mail]',
    amount: 1500,
    taxRate: 20,
    currencySymbol: '$',
    lineItems: [
      { id: '1', description: 'Web Design', qty: '1', rate: '1200' },
      { id: '2', description: 'Hosting', qty: '1', rate: '300' }
    ]
  })
})

// Save the PDF
const blob = await res.blob()
const url = URL.createObjectURL(blob)
const a = document.createElement('a')
a.href = url
a.download = 'invoice.pdf'
a.click()