Skip to main content
POST
/
apps
/
pdf
/
v1
/
preview
cURL
curl --request POST \
  --url https://api.invopop.com/apps/pdf/v1/preview \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "logo_url": "<string>",
  "logo_height": 123,
  "locale": "<string>",
  "date_format": "<string>",
  "hide_promo": true,
  "layout": "A4",
  "data": {}
}'
This response does not have an example.
The PDF Preview API converts GOBL Envelopes into PDF documents, allowing you to preview and validate your invoices before submitting them to a workflow. To get started, make sure the PDF Generator app is enabled in your account.

Authorizations

​
Authorization
string
header
required

Use the Bearer scheme with a valid JWT token to authenticate requests. Example: Authorization: Bearer <token>

Body

application/json
​
logo_url
string<uri>

URL of the logo to include in the PDF.

​
logo_height
integer

Height of the logo in pixels.

​
locale
string

Locale to use for the PDF generation (e.g., "es").

​
date_format
string

Date format to use in the PDF (e.g., "%Y-%m-%d"). Keys: %Y = full year, %m = month, %d = day.

​
hide_promo
boolean

Whether to hide the Invopop footer.

​
layout
enum<string>

Layout to use for the PDF (e.g., "Letter").

Available options:
A4,
Letter,
DIN5008
​
data
object

The complete GOBL Envelope to convert.

Response

Successfully generated PDF preview.

The response is of type file.

⌘I