settings

Preview Invoice Pdf Design

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

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)

Request body

templatestring nullable
accent_colorstring nullable
accent_color_modestring nullable
accent_cmykobject nullable
muted_colorstring nullable
muted_color_modestring nullable
muted_cmykobject nullable
text_colorstring nullable
text_color_modestring nullable
text_cmykobject nullable
logo_urlstring nullable
logo_size_mminteger nullable
page_sizestring nullable
footer_textstring nullable
footer_text_nlstring nullable
footer_text_enstring nullable
layoutobject nullable
table_styleobject nullable
typographyobject nullable
invoice_idinteger nullable
customobject nullable
formatstring nullable

Response

Successful Response

unknown required

Changes

No recorded changes to this operation across all 1 revision of this API.