---
title: "Preview Invoice Pdf Design"
method: POST
path: "/api/v1/settings/invoice-pdf/preview"
tags: ["settings"]
---

# Preview Invoice Pdf Design

`POST /api/v1/settings/invoice-pdf/preview`

## Request

- Base URL: `https://api.peil.app` (the document declares no server; this is the origin it was published from)
- URL: `https://api.peil.app/api/v1/settings/invoice-pdf/preview`
- Auth: OAuth 2 (password, token URL `/api/v1/auth/jwt/login`)

Render a sample invoice with the given branding — for the live design editor preview.

## Request body

- InvoicePdfPreviewRequest
  - `template` string, nullable
  - `accent_color` string, nullable
  - `accent_color_mode` string, nullable
  - `accent_cmyk` object, nullable
  - `muted_color` string, nullable
  - `muted_color_mode` string, nullable
  - `muted_cmyk` object, nullable
  - `text_color` string, nullable
  - `text_color_mode` string, nullable
  - `text_cmyk` object, nullable
  - `logo_url` string, nullable
  - `logo_size_mm` integer, nullable
  - `page_size` string, nullable
  - `footer_text` string, nullable
  - `footer_text_nl` string, nullable
  - `footer_text_en` string, nullable
  - `layout` object, nullable
  - `table_style` object, nullable
  - `typography` object, nullable
  - `invoice_id` integer, nullable
  - `custom` object, nullable
  - `format` string, nullable

## Response `200`

Successful Response

- unknown

## Other responses

- `422`: Validation Error

---

[API](https://skmtc.dev/peil/apis/peil-api.md) · [All operations](https://skmtc.dev/peil/apis/peil-api/llms.txt) · [OpenAPI document](https://skmtc.dev/peil/apis/peil-api/revisions/ee3ca1246dde?raw)